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

Schema Registry

put

Set the default compatibility mode

Body
compatibilitystringRequired
Responses
204Success

No content

put/api/v1/environments/{name}/proxy/api/v1/sr/default/config
PUT /api/v1/environments/{name}/proxy/api/v1/sr/default/config HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "compatibility": "text"
}

No content

get

Get the default compatibility mode

Responses
200Success
application/json
compatibilitystringOptional
get/api/v1/environments/{name}/proxy/api/v1/sr/default/config
GET /api/v1/environments/{name}/proxy/api/v1/sr/default/config HTTP/1.1
Accept: */*
{
  "compatibility": "text"
}
get

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

Responses
200Success
application/json
formatsstring[]Optional
get/api/v1/environments/{name}/proxy/api/v1/sr/default/formats
GET /api/v1/environments/{name}/proxy/api/v1/sr/default/formats HTTP/1.1
Accept: */*
{
  "formats": [
    "text"
  ]
}
put

Set/unset a subject's compatibility mode

Path parameters
subject_namestringRequired

The subject name

Body
compatibilitystringRequired
Responses
204Success

No content

put/api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/config
PUT /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/config HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "compatibility": "text"
}

No content

put

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

Path parameters
subject_namestringRequired

The subject name

Body
schemastringRequired
formatstringOptional
Responses
200Success
application/json
versionintegerRequired
schemaIdstringRequired
put/api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/current-version
PUT /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/current-version HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 33

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

Deletes a specific Schema Registry subject version

Path parameters
subject_namestringRequired

The subject name

p1integerRequired
Responses
204Success

No content

delete/api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1}
DELETE /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1} HTTP/1.1
Accept: */*

No content

delete

Deletes a subject from Schema Registry

Path parameters
p1stringRequired
Responses
204Success

No content

delete/api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{p1}
DELETE /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{p1} HTTP/1.1
Accept: */*

No content

delete

Deletes a specific Schema Registry subject version

Path parameters
subject_namestringRequired

The subject name

p1integerRequired
Responses
204Success

No content

delete/api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1}
DELETE /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1} HTTP/1.1
Accept: */*

No content

Last updated

Was this helpful?