More
Сhoose
Apicurio Registry API [v2]

Apicurio Registry API [v2]

#developer_toolsv2.4.x

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}.

Developer Resources
API Metadata
  • Providerapicurio.local
  • Versionv2.4.x
  • Added2/3/2021
  • Last Update3/6/2023
Next Steps

Looking to integrate Apicurio Registry API [v2] into your project? Our team can help you build custom connectors.

Get Integration Help