Skip to main content
API docs by Redocly

Pandaproxy Schema Registry (1.0.1)

Get the compatibility level for a subject.

path Parameters
subject
required
string

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "compatibilityLevel": "string"
}

Set the compatibility level for a subject.

path Parameters
subject
required
string
Request Body schema:
compatibility
string

Responses

Request samples

Content type
{
  • "compatibility": "string"
}

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "compatibility": "string"
}

Get the global compatibility level.

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "compatibilityLevel": "string"
}

Set the global compatibility level.

Request Body schema:
compatibility
string

Responses

Request samples

Content type
{
  • "compatibility": "string"
}

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "compatibility": "string"
}

Get the global mode.

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "mode": "string"
}

Get the supported schema types.

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
[
  • "string"
]

Get a schema by ID.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "schemaType": "string",
  • "schema": "string"
}

Get a list of subject-version for the schema ID.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
[
  • {
    }
]

Retrieve a list of subjects.

query Parameters
deleted
string

Responses

Response samples

Content type
[
  • "string"
]

Check if a schema is already registered for the subject.

path Parameters
subject
required
string
Request Body schema:
schema
string
schemaType
string
Array of objects

Responses

Request samples

Content type
{
  • "schema": "string",
  • "schemaType": "string",
  • "references": [
    ]
}

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "subject": "string",
  • "version": 0,
  • "id": 0,
  • "schemaType": "string",
  • "references": [
    ],
  • "schema": "string"
}

Delete all schemas for the subject.

path Parameters
subject
required
string
query Parameters
permanent
boolean

Responses

Response samples

Content type
application/vnd.schemaregistry.v1+json
[
  • 0
]

Retrieve a list of versions for a subject.

path Parameters
subject
required
string
query Parameters
deleted
string

Responses

Response samples

Content type
[
  • 0
]

Create a new schema for the subject.

path Parameters
subject
required
string
Request Body schema:
schema
string
schemaType
string
Array of objects

Responses

Request samples

Content type
{
  • "schema": "string",
  • "schemaType": "string",
  • "references": [
    ]
}

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "id": 0
}

Retrieve a schema for the subject and version.

path Parameters
subject
required
string
version
required
string
query Parameters
deleted
string

Responses

Response samples

Content type
{
  • "subject": "string",
  • "version": 0,
  • "id": 0,
  • "schemaType": "string",
  • "references": [
    ],
  • "schema": "string"
}

Delete a schema for the subject and version.

path Parameters
subject
required
string
version
required
string
query Parameters
permanent
boolean

Responses

Response samples

Content type
0
0

Retrieve a schema for the subject and version.

path Parameters
subject
required
string
version
required
string
query Parameters
deleted
string

Responses

Response samples

Content type
"string"

Retrieve a list of schema IDs that reference the subject and version.

path Parameters
subject
required
string
version
required
string

Responses

Response samples

Content type
[
  • 0
]

Test compatibility of a schema for the subject and version.

path Parameters
subject
required
string
version
required
integer
Request Body schema:
schema
string
schemaType
string
Array of objects

Responses

Request samples

Content type
{
  • "schema": "string",
  • "schemaType": "string",
  • "references": [
    ]
}

Response samples

Content type
application/vnd.schemaregistry.v1+json
{
  • "id": 0
}