Retrieve

API Reference

Databases

Schema Registry

Config

Retrieve Schema Registry Configuration for a kafka Cluster

client.databases.schemaRegistry.config.retrieve(stringdatabaseClusterUuid, RequestOptionsoptions?): ConfigRetrieveResponse { compatibility_level }

get/v2/databases/{database_cluster_uuid}/schema-registry/config

To retrieve the Schema Registry configuration for a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry/config. The response is a JSON object with a compatibility_level key, which is set to an object containing any database configuration parameters.

ParametersExpand Collapse

databaseClusterUuid: string

ReturnsExpand Collapse

ConfigRetrieveResponse { compatibility_level }

compatibility_level: "NONE" | "BACKWARD" | "BACKWARD_TRANSITIVE" | 4 more

The compatibility level of the schema registry.

Accepts one of the following:

"NONE"

"BACKWARD"

"BACKWARD_TRANSITIVE"

"FORWARD"

"FORWARD_TRANSITIVE"

"FULL"

"FULL_TRANSITIVE"

Retrieve Schema Registry Configuration for a kafka Cluster

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const config = await client.databases.schemaRegistry.config.retrieve('9cc10173-e9ea-4176-9dbc-a4cee4c4ff30');

console.log(config.compatibility_level);

200 example

{
  "compatibility_level": "NONE"
}

Returns Examples

200 example

{
  "compatibility_level": "NONE"
}