v58

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-036490116.2 KB

Clusters

Update a cluster

User must have the CLUSTER_DEFINITION[UPDATE] permission.

Kafka virtual cluster lifecycle: removing all backends is a plain edit. On a deployed virtual cluster the update is accepted (200) and the cluster moves to lifecycleState PENDING: the gateway keeps serving the previous configuration, and the emptied configuration cannot be deployed until at least one backend is added back (the deploy endpoint rejects virtual clusters without backends).

put/clusters/{clusterId}

Request body

namestring

descriptionstring

configurationobject

Response

Cluster updated

idstring

crossIdstring

Portable identifier for cross-environment references. Immutable after creation.

type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'

createdAtstring date-time

updatedAtstring date-time

namestring

descriptionstring

configurationobject

groupsstring[]

lifecycleState'UNDEPLOYED' | 'DEPLOYED' | 'PENDING'

Current lifecycle state of the cluster.

deployedAtstring date-time

Last deployment or undeployment timestamp.

versioninteger

Deployment version, incremented on each deploy.