Sign in

v7

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-07355390.1 KB
kafka_cluster

Update Kafka cluster

Updates the configuration properties of an existing Kafka cluster. Sensitive properties (passwords, secrets, etc.) are automatically redacted in the response.

patch/kafka-clusters/{cluster_name}

Path parameters

cluster_namestring required

Kafka cluster name

Request body

propertiesobject 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

created_atstring required

Created at

When the Kafka cluster configuration was created.

namestring hostname required

Kafka cluster name

Valid name to use as a kafka cluster identifier. MUST conform a valid hostname format.

propertiesobject required

Properties

Properties for connecting to the kafka cluster.

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