Retrieve

API Reference

Databases

Schema Registry

Config

Retrieve Schema Registry Configuration for a kafka Cluster

databases.schema_registry.config.retrieve(strdatabase_cluster_uuid) -> ConfigRetrieveResponse

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

database_cluster_uuid: str

ReturnsExpand Collapse

class ConfigRetrieveResponse: …

compatibility_level: Literal["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

python

• http
• typescript
• python

from gradient import Gradient

client = Gradient()
config = client.databases.schema_registry.config.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(config.compatibility_level)

200 example

{
  "compatibility_level": "NONE"
}

Returns Examples

200 example

{
  "compatibility_level": "NONE"
}