---
title: "Update Kafka cluster"
method: PATCH
path: "/kafka-clusters/{cluster_name}"
tags: ["kafka_cluster"]
---

# Update Kafka cluster

`PATCH /kafka-clusters/{cluster_name}`

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

## Path parameters

- `cluster_name` string, required

## Request body

- UpdateKafkaClusterRequest — 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](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md).

## Response `200`

Kafka cluster updated successfully

- SimpleKafkaClusterResponse — Kafka cluster simple response.
  - `created_at` string, required — # Created at When the Kafka cluster configuration was created.
  - `info` SchemaInfo[] — # Info List of configuration/deprecation information related to this deployment.
    - `code` string, nullable
    - `message` string, required
  - `name` string, hostname, required — # Kafka cluster name Valid name to use as a kafka cluster identifier. MUST conform 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](https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md).

## Other responses

- `400` — Bad request
- `404` — Not found
- `405` — Method not allowed
- `409` — Conflict
- `500` — Internal server error

---

[API](https://skmtc.net/restatedev/apis/admin-api.md) · [All operations](https://skmtc.net/restatedev/apis/admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/restatedev/admin-api/versions/9776a5b4a837/schema)