Skip to main content
PATCH
Update Kafka cluster

Path Parameters

cluster_name
string
required

Kafka cluster name

Body

application/json

Update Kafka cluster request

properties
object
required

Properties

Updated Kafka cluster configuration properties. Must contain either 'bootstrap.servers' or 'metadata.broker.list'.

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

Response

Kafka cluster updated successfully

Kafka cluster simple response.

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.

info
object[]

Info

List of configuration/deprecation information related to this deployment.