Apicurio Registry API V2

Apicurio Registry API [v2]

API version: 2.6.x

Auth

No authentication required.

Base URL

Not specified.

Setup

1. No auth setup needed
2. GET /admin/artifactTypes -- verify access
3. POST /admin/rules -- create first rules

Endpoints

65 endpoints across 6 groups. See references/api-spec.lap for full details.

ids

admin

system

search

groups

users

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Get globalId details?" -> GET /ids/globalIds/{globalId}
• "List all artifactTypes?" -> GET /admin/artifactTypes
• "List all rules?" -> GET /admin/rules
• "Create a rule?" -> POST /admin/rules
• "Get rule details?" -> GET /admin/rules/{rule}
• "Update a rule?" -> PUT /admin/rules/{rule}
• "Delete a rule?" -> DELETE /admin/rules/{rule}
• "List all info?" -> GET /system/info
• "List all artifacts?" -> GET /search/artifacts
• "Create a artifact?" -> POST /search/artifacts
• "List all export?" -> GET /admin/export
• "Create a import?" -> POST /admin/import
• "List all meta?" -> GET /groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta
• "Get version details?" -> GET /groups/{groupId}/artifacts/{artifactId}/versions/{version}
• "Delete a version?" -> DELETE /groups/{groupId}/artifacts/{artifactId}/versions/{version}
• "List all rules?" -> GET /groups/{groupId}/artifacts/{artifactId}/rules
• "Create a rule?" -> POST /groups/{groupId}/artifacts/{artifactId}/rules
• "Get rule details?" -> GET /groups/{groupId}/artifacts/{artifactId}/rules/{rule}
• "Update a rule?" -> PUT /groups/{groupId}/artifacts/{artifactId}/rules/{rule}
• "Delete a rule?" -> DELETE /groups/{groupId}/artifacts/{artifactId}/rules/{rule}
• "Get roleMapping details?" -> GET /admin/roleMappings/{principalId}
• "Update a roleMapping?" -> PUT /admin/roleMappings/{principalId}
• "Delete a roleMapping?" -> DELETE /admin/roleMappings/{principalId}
• "List all roleMappings?" -> GET /admin/roleMappings
• "Create a roleMapping?" -> POST /admin/roleMappings
• "List all me?" -> GET /users/me
• "List all references?" -> GET /ids/contentHashes/{contentHash}/references
• "List all references?" -> GET /ids/contentIds/{contentId}/references
• "List all references?" -> GET /ids/globalIds/{globalId}/references
• "List all references?" -> GET /groups/{groupId}/artifacts/{artifactId}/versions/{version}/references
• "List all properties?" -> GET /admin/config/properties
• "Get property details?" -> GET /admin/config/properties/{propertyName}
• "Update a property?" -> PUT /admin/config/properties/{propertyName}
• "Delete a property?" -> DELETE /admin/config/properties/{propertyName}
• "List all limits?" -> GET /system/limits
• "Get artifact details?" -> GET /groups/{groupId}/artifacts/{artifactId}
• "Update a artifact?" -> PUT /groups/{groupId}/artifacts/{artifactId}
• "Delete a artifact?" -> DELETE /groups/{groupId}/artifacts/{artifactId}
• "List all artifacts?" -> GET /groups/{groupId}/artifacts
• "Create a artifact?" -> POST /groups/{groupId}/artifacts
• "List all versions?" -> GET /groups/{groupId}/artifacts/{artifactId}/versions
• "Create a version?" -> POST /groups/{groupId}/artifacts/{artifactId}/versions
• "List all owner?" -> GET /groups/{groupId}/artifacts/{artifactId}/owner
• "Get group details?" -> GET /groups/{groupId}
• "Delete a group?" -> DELETE /groups/{groupId}
• "List all groups?" -> GET /groups
• "Create a group?" -> POST /groups
• "List all meta?" -> GET /groups/{groupId}/artifacts/{artifactId}/meta
• "Create a meta?" -> POST /groups/{groupId}/artifacts/{artifactId}/meta
• "List all comments?" -> GET /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments
• "Create a comment?" -> POST /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments
• "Update a comment?" -> PUT /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments/{commentId}
• "Delete a comment?" -> DELETE /groups/{groupId}/artifacts/{artifactId}/versions/{version}/comments/{commentId}
• "Get contentId details?" -> GET /ids/contentIds/{contentId}
• "Get contentHashe details?" -> GET /ids/contentHashes/{contentHash}

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP