GRgravitee-io
Clusters

Undeploy a cluster

Changed on

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

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/clusters/{clusterId}/_undeploy
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

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.

Changes