Apicurio Registry API [v2] API

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

Apicurio Registry API [v2] is a development API from apicurio.local. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 64 endpoints.

At a glance

Authentication

No auth

HTTPS

Yes

CORS

Unknown

Category

Development

Base URL

http://apicurio.local

Version

2.4.x

Endpoints

64

OpenAPI

Specification ↗

Spec updated

2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "http://apicurio.local/admin/artifactTypes" \
  -H "Accept: application/json"

const response = await fetch("http://apicurio.local/admin/artifactTypes", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "http://apicurio.local/admin/artifactTypes",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions