Schema Overview

This is the default Schema Registry dashboard.

To navigate to this page:

From the home page, click the name of the target system
Click on the Accounts tab
Click the name of the target Account
Select the Schema Registry tab

Schemas

From the dashboard it is possible to View, Create and Delete schemas.

Guides on how to Create, Update and Delete schemas are found within the subsequent sections of this guide.

Schema List

Schemas are displayed in a table which is searchable and can be ordered by Name, Format, Description, Version, Revision or Last Updated.

The latest Description, Version and Revision are shown in their subsequent columns in each row. The table has a convenient search bar for finding specific schemas.

Clicking on the schema name will take you to the detailed overview of that schema.

Clicking on the Create Schema button will open a side-draw form. Refer to the Create Schema guide for more details on how to use this.

Each schema in the table has three dots after the Last Updated column. Clicking on this will expose the option to delete the entire schema. Refer to the delete guide for more information on this.

API

Access the Schema Registry API's requires an API token.

curl https://${CONTROL_PLANE_URL}/api/schema-registry/alpha/${ACCOUNT_ID}/schemas \
  --header 'authorization: Bearer ${TOKEN}' \
  --header 'content-type: application/json'

Which will return something like:

{
  "schemas": [
    {
      "version": 1,
      "revision": 1,
      "time": "2025-09-08T10:19:53.843111+10:00",
      "name": "Person",
      "definition": "{}",
      "format": "jsonschema",
      "compat_policy": "none",
      "description": "A Person schema",
      "metadata": null
    },
    {
      "version": 1,
      "revision": 2,
      "time": "2025-09-08T10:20:22.317318+10:00",
      "name": "Person",
      "definition": "{\"$id\":\"https://example.com/person.schema.json\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Person\",\"type\":\"object\",\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"The person's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"The person's last name.\"},\"age\":{\"description\":\"Age in years which must be equal to or greater than zero.\",\"type\":\"integer\",\"minimum\":0}}}",
      "format": "jsonschema",
      "compat_policy": "none",
      "description": "A Person schema",
      "metadata": null
    },
    {
      "version": 1,
      "revision": 3,
      "time": "2025-09-08T10:21:22.01632+10:00",
      "name": "Person",
      "definition": "{\"$id\":\"https://example.com/person.schema.json\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Person\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"The person's first name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"The person's last name.\"},\"age\":{\"description\":\"Age in years which must be equal to or greater than zero.\",\"type\":\"integer\",\"minimum\":0}}}",
      "format": "jsonschema",
      "compat_policy": "none",
      "description": "A Person schema - no additional properties",
      "metadata": null
    }
  ]
}

Refer to the API documentation for more information. For Control Plane this will be https://${CONTROL_PLANE_URL}/api-docs