Schema Registry

Get default compatibility mode

get

Get the default compatibility mode

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

compatibilitystringOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/sr/default/config

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/json

compatibilitystringRequired

Responses

204Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/sr/default/config

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

formatsstring[]Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/sr/default/formats

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

subject_namestringRequired

The subject name

Body

application/json

compatibilitystringRequired

Responses

204Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/config

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

subject_namestringRequired

The subject name

Body

application/json

schemastringRequired

formatstringOptional

Responses

200Success

application/json

versionintegerRequired

schemaIdstringRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/current-version

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

subject_namestringRequired

The subject name

p1integerRequired

Responses

204Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1}

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

p1stringRequired

Responses

204Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{p1}

HTTPcURLJavaScriptPython

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