Skip to main content
GET
Get Kafka cluster

Path Parameters

cluster_name
string
required

Kafka cluster name

Query Parameters

include_subscriptions
boolean

If true, includes the list of subscriptions using this cluster.

Response

Kafka cluster details

Kafka cluster details with subscriptions.

created_at
string
required

Created at

When the Kafka cluster configuration was created.

name
string<hostname>
required

Cluster Name

Name for the Kafka cluster, used to identify this Kafka cluster configuration in subscriptions. Must be a valid hostname format.

properties
object
required

Properties

Properties for connecting to the kafka cluster.

For a full list of configuration properties, check the librdkafka documentation.

subscriptions
object[]
required

Subscriptions

Subscriptions to this Kafka cluster, returned only when include_subscriptions is enabled.

info
object[]

Info

List of configuration/deprecation information related to this deployment.