v58

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

Clusters

Undeploy a cluster

Undeploy the cluster from the gateway. Sets lifecycle state to UNDEPLOYED.

A Kafka virtual cluster cannot be undeployed while a started Kafka Native API is bound to it (via a native-kafka-virtual-cluster endpoint): the request is rejected with 400 so the started API is never left pointing at an undeployed cluster.

post/clusters/{clusterId}/_undeploy

Response

Cluster undeployed

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.