For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schema Registry

Get default compatibility mode

get

Get the default compatibility mode

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
compatibilitystringOptional
get/api/v1/environments/{environment}/proxy/api/v1/sr/default/config
GET /api/v1/environments/{environment}/proxy/api/v1/sr/default/config HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "compatibility": "text"
}

Set default compatibility mode

put

Set the default compatibility mode

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
compatibilitystringRequired
Responses
204Success

No content

put/api/v1/environments/{environment}/proxy/api/v1/sr/default/config
PUT /api/v1/environments/{environment}/proxy/api/v1/sr/default/config HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "compatibility": "text"
}

No content

Get schema formats

get

Get the set of schema formats used in this specific collection of subjects

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
formatsstring[]Optional
get/api/v1/environments/{environment}/proxy/api/v1/sr/default/formats
GET /api/v1/environments/{environment}/proxy/api/v1/sr/default/formats HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "formats": [
    "text"
  ]
}

Set subject compatibility mode

put

Set/unset a subject's compatibility mode

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
subject_namestringRequired

The subject name

Body
compatibilitystringRequired
Responses
204Success

No content

put/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/config
PUT /api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/config HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "compatibility": "text"
}

No content

Create schema

put

Register a new Schema version, creating a subject it doesn't exist

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
subject_namestringRequired

The subject name

Body
schemastringRequired
formatstringOptional
Responses
200Success
application/json
versionintegerRequired
schemaIdstringRequired
put/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/current-version
PUT /api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/current-version HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "schema": "text",
  "format": "text"
}
{
  "version": 1,
  "schemaId": "text"
}

Delete schema version

delete

Deletes a specific Schema Registry subject version

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
subject_namestringRequired

The subject name

p1integerRequired
Responses
204Success

No content

delete/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1}
DELETE /api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete schema subject

delete

Deletes a subject from Schema Registry

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
p1stringRequired
Responses
204Success

No content

delete/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{p1}
DELETE /api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{p1} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated

Was this helpful?