v58

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

Create a cluster

User must have the ENVIRONMENT_CLUSTER[CREATE] permission.

post/clusters

Request body

type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER' required
crossIdstring

Portable identifier for cross-environment references. Auto-generated from name if not provided.

namestring required
descriptionstring
configurationobject required

Response

Cluster created

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.