Schema Registry

put

Set the default compatibility mode

Body
compatibilitystringRequired
Responses
204Success

No content

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

{
  "compatibility": "text"
}

No content

get

Get the default compatibility mode

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

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

Responses
200Success
application/json
get
GET /api/v1/environments/{name}/proxy/api/v1/sr/default/formats HTTP/1.1
Host: 
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
PUT /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/config HTTP/1.1
Host: 
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
put
PUT /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/current-version HTTP/1.1
Host: 
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
DELETE /api/v1/environments/{name}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1} HTTP/1.1
Host: 
Accept: */*

No content

delete

Deletes a subject from Schema Registry

Path parameters
p1stringRequired
Responses
204Success

No content

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

No content

delete

Deletes a specific Schema Registry subject version

Path parameters
subject_namestringRequired

The subject name

p1integerRequired
Responses
204Success

No content

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

No content

Last updated

Was this helpful?