Apicurio Registry API [v2]

apicurio · Developer Tools

Developer Tools No Auth Free & Open developer_tools

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

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List groups

Returns a list of all groups. This list is paged.

https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups?limit=10&order=asc&offset=0&orderby=date

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups?limit=10&order=asc&offset=0&orderby=date"

import requests
params = {
    "limit": "10",
    "order": "asc",
    "offset": "0",
    "orderby": "date"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups');
url.searchParams.set('limit', '10');
url.searchParams.set('order', 'asc');
url.searchParams.set('offset', '0');
url.searchParams.set('orderby', 'date');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups")
	q := baseURL.Query()
	q.Set("limit", "10")
	q.Set("order", "asc")
	q.Set("offset", "0")
	q.Set("orderby", "date")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups")
uri.query = URI.encode_www_form({
  "limit" => "10",
  "order" => "asc",
  "offset" => "0",
  "orderby" => "date"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/groups?" . http_build_query([
    "limit" => "10",
    "order" => "asc",
    "offset" => "0",
    "orderby" => "date"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Export registry data

Exports registry data as a ZIP archive.

https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export?forBrowser=true

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export?forBrowser=true"

import requests
params = {
    "forBrowser": "true"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export');
url.searchParams.set('forBrowser', 'true');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export")
	q := baseURL.Query()
	q.Set("forBrowser", "true")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export")
uri.query = URI.encode_www_form({
  "forBrowser" => "true"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/admin/export?" . http_build_query([
    "forBrowser" => "true"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Search for artifacts

Returns a paginated list of all artifacts that match the provided filter criteria.

https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts?name=test&group=example&limit=20&order=asc&labels=example&offset=0&orderby=date&globalId=1&contentId=1&properties=example&description=test

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts?name=test&group=example&limit=20&order=asc&labels=example&offset=0&orderby=date&globalId=1&contentId=1&properties=example&description=test"

import requests
params = {
    "name": "test",
    "group": "example",
    "limit": "20",
    "order": "asc",
    "labels": "example",
    "offset": "0",
    "orderby": "date",
    "globalId": "1",
    "contentId": "1",
    "properties": "example",
    "description": "test"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts');
url.searchParams.set('name', 'test');
url.searchParams.set('group', 'example');
url.searchParams.set('limit', '20');
url.searchParams.set('order', 'asc');
url.searchParams.set('labels', 'example');
url.searchParams.set('offset', '0');
url.searchParams.set('orderby', 'date');
url.searchParams.set('globalId', '1');
url.searchParams.set('contentId', '1');
url.searchParams.set('properties', 'example');
url.searchParams.set('description', 'test');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts")
	q := baseURL.Query()
	q.Set("name", "test")
	q.Set("group", "example")
	q.Set("limit", "20")
	q.Set("order", "asc")
	q.Set("labels", "example")
	q.Set("offset", "0")
	q.Set("orderby", "date")
	q.Set("globalId", "1")
	q.Set("contentId", "1")
	q.Set("properties", "example")
	q.Set("description", "test")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts")
uri.query = URI.encode_www_form({
  "name" => "test",
  "group" => "example",
  "limit" => "20",
  "order" => "asc",
  "labels" => "example",
  "offset" => "0",
  "orderby" => "date",
  "globalId" => "1",
  "contentId" => "1",
  "properties" => "example",
  "description" => "test"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/apicurio.local/registry/2.4.x/search/artifacts?" . http_build_query([
    "name" => "test",
    "group" => "example",
    "limit" => "20",
    "order" => "asc",
    "labels" => "example",
    "offset" => "0",
    "orderby" => "date",
    "globalId" => "1",
    "contentId" => "1",
    "properties" => "example",
    "description" => "test"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Apicurio Registry API [v2]?

Apicurio Registry API [v2] is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Apicurio Registry API [v2] is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗