Retrieve Subject

API Reference

Databases

Schema Registry

Config

Retrieve Schema Registry Configuration for a Subject of kafka Cluster

client.databases.schemaRegistry.config.retrieveSubject(stringsubjectName, ConfigRetrieveSubjectParams { database_cluster_uuid } params, RequestOptionsoptions?): ConfigRetrieveSubjectResponse { compatibility_level, subject_name }

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

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

ParametersExpand Collapse

subjectName: string

params: ConfigRetrieveSubjectParams { database_cluster_uuid }

database_cluster_uuid: string

A unique identifier for a database cluster.

formatuuid

ReturnsExpand Collapse

ConfigRetrieveSubjectResponse { compatibility_level, subject_name }

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"

subject_name: string

The name of the schema subject.

Retrieve Schema Registry Configuration for a Subject of kafka Cluster

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.databases.schemaRegistry.config.retrieveSubject('customer-schema', {
  database_cluster_uuid: '9cc10173-e9ea-4176-9dbc-a4cee4c4ff30',
});

console.log(response.compatibility_level);

200 example

{
  "compatibility_level": "NONE",
  "subject_name": "subject_name"
}

Returns Examples

200 example

{
  "compatibility_level": "NONE",
  "subject_name": "subject_name"
}