Apicurio Registry API [v2]
Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their…
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility.
The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata.
The supported artifact types include:
- Apache Avro schema
- AsyncAPI specification
- Google protocol buffers
- GraphQL schema
- JSON Schema
- Kafka Connect schema
- OpenAPI specification
- Web Services Description Language
- XML Schema Definition
Important: The Apicurio Registry REST API is available from https://MY-REGISTRY-URL/apis/registry/v2 by default. Therefore you must prefix all API operation paths with ../apis/registry/v2 in this case. For example: ../apis/registry/v2/ids/globalIds/{globalId}.
Endpoints 64
Artifacts
- GETList artifacts in group
/groups/:groupId/artifacts?limit=0&offset=0&order=asc&orderby=nameReturns a list of all artifacts in the group. This list is paged. - POSTCreate artifact
/groups/:groupId/artifacts?ifExists=FAIL&canonical=trueCreates a new artifact by posting the artifact content. The body of the request should be the raw content of the artifact. This is typically in JSON format… - DELETEDelete artifacts in group
/groups/:groupId/artifactsDeletes all of the artifacts that exist in a given group. - GETGet latest artifact
/groups/:groupId/artifacts/:artifactId?dereference=trueReturns the latest version of the artifact in its raw form. The Content-Type of the response depends on the artifact type. In most cases, this is… - PUTUpdate artifact
/groups/:groupId/artifacts/:artifactIdUpdates an artifact by uploading new content. The body of the request can be the raw content of the artifact or a JSON object containing both the raw content… - DELETEDelete artifact
/groups/:groupId/artifacts/:artifactIdDeletes an artifact completely, resulting in all versions of the artifact also being deleted. This may fail for one of the following reasons: * No artifact… - PUTUpdate artifact state
/groups/:groupId/artifacts/:artifactId/stateUpdates the state of the artifact. For example, you can use this to mark the latest version of an artifact as DEPRECATED. The operation changes the state of… - GETGet artifact content by SHA-256 hash
/ids/contentHashes/:contentHash/Gets the content for an artifact version in the registry using the SHA-256 hash of the content. This content hash may be shared by multiple artifact versions… - GETList artifact references by hash
/ids/contentHashes/:contentHash/referencesReturns a list containing all the artifact references using the artifact content hash. This operation may fail for one of the following reasons: * A server… - GETGet artifact content by ID
/ids/contentIds/:contentId/Gets the content for an artifact version in the registry using the unique content identifier for that content. This content ID may be shared by multiple… - GETList artifact references by content ID
/ids/contentIds/:contentId/referencesReturns a list containing all the artifact references using the artifact content ID. This operation may fail for one of the following reasons: * A server… - GETGet artifact by global ID
/ids/globalIds/:globalId?dereference=trueGets the content for an artifact version in the registry using its globally unique identifier. This operation may fail for one of the following reasons: * No… - GETList artifact references by global ID
/ids/globalIds/:globalId/referencesReturns a list containing all the artifact references using the artifact global ID. This operation may fail for one of the following reasons: * A server error…
Metadata
- GETGet artifact metadata
/groups/:groupId/artifacts/:artifactId/metaGets the metadata for an artifact in the registry. The returned metadata includes both generated (read-only) and editable metadata (such as name and… - PUTUpdate artifact metadata
/groups/:groupId/artifacts/:artifactId/metaUpdates the editable parts of the artifact's metadata. Not all metadata fields can be updated. For example, createdOn and createdBy are both read-only… - POSTGet artifact version metadata by content
/groups/:groupId/artifacts/:artifactId/meta?canonical=trueGets the metadata for an artifact that matches the raw content. Searches the registry for a version of the given artifact matching the content provided in the… - GETGet artifact owner
/groups/:groupId/artifacts/:artifactId/ownerGets the owner of an artifact in the registry. This operation can fail for the following reasons: * No artifact with this artifactId exists (HTTP error 404) *… - PUTUpdate artifact owner
/groups/:groupId/artifacts/:artifactId/ownerChanges the ownership of an artifact. This operation can fail for the following reasons: * No artifact with this artifactId exists (HTTP error 404) * A server… - GETGet artifact version metadata
/groups/:groupId/artifacts/:artifactId/versions/:version/metaRetrieves the metadata for a single version of the artifact. The version metadata is a subset of the artifact metadata and only includes the metadata that is… - PUTUpdate artifact version metadata
/groups/:groupId/artifacts/:artifactId/versions/:version/metaUpdates the user-editable portion of the artifact version's metadata. Only some of the metadata fields are editable by the user. For example, description is… - DELETEDelete artifact version metadata
/groups/:groupId/artifacts/:artifactId/versions/:version/metaDeletes the user-editable metadata properties of the artifact version. Any properties that are not user-editable are preserved. This operation can fail for…
Versions
- GETList artifact versions
/groups/:groupId/artifacts/:artifactId/versions?offset=0&limit=0Returns a list of all versions of the artifact. The result set is paged. This operation can fail for the following reasons: * No artifact with this artifactId… - POSTCreate artifact version
/groups/:groupId/artifacts/:artifactId/versionsCreates a new version of the artifact by uploading new content. The configured rules for the artifact are applied, and if they all pass, the new content is… - GETGet artifact version
/groups/:groupId/artifacts/:artifactId/versions/:version?dereference=trueRetrieves a single version of the artifact content. Both the artifactId and the unique version number must be provided. The Content-Type of the response… - GETGet artifact version
/groups/:groupId/artifacts/:artifactId/versions/:version/referencesRetrieves a single version of the artifact content. Both the artifactId and the unique version number must be provided. The Content-Type of the response… - PUTUpdate artifact version state
/groups/:groupId/artifacts/:artifactId/versions/:version/stateUpdates the state of a specific version of an artifact. For example, you can use this operation to disable a specific version. This operation can fail for the…
Artifact rules
- GETList artifact rules
/groups/:groupId/artifacts/:artifactId/rulesReturns a list of all rules configured for the artifact. The set of rules determines how the content of an artifact can evolve over time. If no rules are… - POSTCreate artifact rule
/groups/:groupId/artifacts/:artifactId/rulesAdds a rule to the list of rules that get applied to the artifact when adding new versions. All configured rules must pass to successfully add a new artifact… - DELETEDelete artifact rules
/groups/:groupId/artifacts/:artifactId/rulesDeletes all of the rules configured for the artifact. After this is done, the global rules apply to the artifact again. This operation can fail for the… - GETGet artifact rule configuration
/groups/:groupId/artifacts/:artifactId/rules/:ruleReturns information about a single rule configured for an artifact. This is useful when you want to know what the current configuration settings are for a… - PUTUpdate artifact rule configuration
/groups/:groupId/artifacts/:artifactId/rules/:ruleUpdates the configuration of a single rule for the artifact. The configuration data is specific to each rule type, so the configuration of the COMPATIBILITY… - DELETEDelete artifact rule
/groups/:groupId/artifacts/:artifactId/rules/:ruleDeletes a rule from the artifact. This results in the rule no longer applying for this artifact. If this is the only rule configured for the artifact, this is… - PUTTest update artifact
/groups/:groupId/artifacts/:artifactId/testTests whether an update to the artifact's content *would* succeed for the provided content. Ultimately, this applies any rules configured for the artifact…
Global rules
- GETList global rules
/admin/rulesGets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error 500) - POSTCreate global rule
/admin/rulesAdds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error 400) * The… - DELETEDelete all global rules
/admin/rulesDeletes all globally configured rules. This operation can fail for the following reasons: * A server error occurred (HTTP error 500) - GETGet global rule configuration
/admin/rules/:ruleReturns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error 400) *… - PUTUpdate global rule configuration
/admin/rules/:ruleUpdates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error 400) * No… - DELETEDelete global rule
/admin/rules/:ruleDeletes a single global rule. If this is the only rule configured, this is the same as deleting all rules. This operation can fail for the following reasons:…
Search
- GETSearch for artifacts
/search/artifacts?name=string&offset=0&limit=20&order=asc&orderby=name&labels=string&properties=string&description=string&group=string&globalId=0&contentId=0Returns a paginated list of all artifacts that match the provided filter criteria. - POSTSearch for artifacts by content
/search/artifacts?canonical=true&artifactType=AVRO&offset=0&limit=20&order=asc&orderby=nameReturns a paginated list of all artifacts with at least one version that matches the posted content.
Admin
- GETList all configuration properties
/admin/config/propertiesReturns a list of all configuration properties that have been set. The list is not paged. This operation may fail for one of the following reasons: * A server… - GETGet configuration property value
/admin/config/properties/:propertyNameReturns the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP… - PUTUpdate a configuration property
/admin/config/properties/:propertyNameUpdates the value of a single configuration property. This operation may fail for one of the following reasons: * Property not found or not configured (HTTP… - DELETEReset a configuration property
/admin/config/properties/:propertyNameResets the value of a single configuration property. This will return the property to its default value (see external documentation for supported properties… - GETExport registry data
/admin/export?forBrowser=trueExports registry data as a ZIP archive. - POSTImport registry data
/admin/importImports registry data that was previously exported using the /admin/export operation. - GETList logging configurations
/admin/loggersList all of the configured logging levels. These override the default logging configuration. - GETGet a single logger configuration
/admin/loggers/:loggerReturns the configured logger configuration for the provided logger name, if no logger configuration is persisted it will return the current default log… - PUTSet a logger's configuration
/admin/loggers/:loggerConfigures the logger referenced by the provided logger name with the given configuration. - DELETERemoves logger configuration
/admin/loggers/:loggerRemoves the configured logger configuration (if any) for the given logger. - GETList all role mappings
/admin/roleMappingsGets a list of all role mappings configured in the registry (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error… - POSTCreate a new role mapping
/admin/roleMappingsCreates a new mapping between a user/principal and a role. This operation can fail for the following reasons: * A server error occurred (HTTP error 500) - GETReturn a single role mapping
/admin/roleMappings/:principalIdGets the details of a single role mapping (by principalId). This operation can fail for the following reasons: * No role mapping for the principalId exists… - PUTUpdate a role mapping
/admin/roleMappings/:principalIdUpdates a single role mapping for one user/principal. This operation can fail for the following reasons: * No role mapping for the principalId exists (HTTP… - DELETEDelete a role mapping
/admin/roleMappings/:principalIdDeletes a single role mapping, effectively denying access to a user/principal. This operation can fail for the following reasons: * No role mapping for the…
System
- GETGet system information
/system/infoThis operation retrieves information about the running registry system, such as the version of the software and when it was built. - GETGet resource limits information
/system/limitsThis operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry.
Users
- GETGet current user
/users/meReturns information about the currently authenticated user.
Groups
- GETList groups
/groups?limit=0&offset=0&order=asc&orderby=nameReturns a list of all groups. This list is paged. - POSTCreate a new group
/groupsCreates a new group. This operation can fail for the following reasons: * A server error occurred (HTTP error 500) * The group already exist (HTTP error 409) - GETGet a group by the specified ID.
/groups/:groupIdReturns a group using the specified id. This operation can fail for the following reasons: * No group exists with the specified ID (HTTP error 404) * A server… - DELETEDelete a group by the specified ID.
/groups/:groupIdDeletes a group by identifier. This operation can fail for the following reasons: * A server error occurred (HTTP error 500) * The group does not exist (HTTP…
Artifact Type
- GETList artifact types
/admin/artifactTypesGets a list of all the configured artifact types. This operation can fail for the following reasons: * A server error occurred (HTTP error 500)
API details
- Base URL
http://apicurio.local- Authentication
- None declared in the description
- Operations
- 64 operations on 37 pathsGET 32PUT 12DELETE 11POST 9
- Main resources
- Admin 22Artifacts 15Metadata 8Artifact rules 7Global rules 6Versions 5Groups 4Search 2System 2Artifact Type 1
- Response formats
application/jsonapplication/zip- Description format
- OpenAPI 3.0.2, API version
2.4.x - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Apicurio Registry API [v2] in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Apicurio Registry API [v2] collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List artifacts in group” (GET /groups/:groupId/artifacts?limit=0&offset=0&order=asc&orderby=name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Apicurio Registry API [v2]?
Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their… It is listed under Developer tools and has 64 endpoints.
Who publishes the Apicurio Registry API [v2]?
It is listed from Apicurio's public API description (an OpenAPI document), not published by Apicurio on Swastik Codes. Anyone who controls its domain can claim the profile by adding a DNS TXT record.
What is the base URL of the Apicurio Registry API [v2]?
Requests go to http://apicurio.local. Endpoint paths are added to this base URL.
How do I authenticate with the Apicurio Registry API [v2]?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Apicurio Registry API [v2] have?
64 operations on 37 paths (32 GET, 12 PUT, 11 DELETE, 9 POST). The largest groups are Admin, Artifacts, Metadata, Artifact rules.
Is forking the Apicurio Registry API [v2] free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.