GRgravitee-io
Clusters

Update a cluster

Changed on

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

  • 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}
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

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.

Changes

  • ac9b3975b952Revision changes
    • warning

      added the new KAFKA_VIRTUAL_CLUSTER enum value to the response property for the response status

  • 86ed32989ff4Revision changes
    • warning

      added the new KAFKA_CLUSTER_STANDALONE enum value to the response property for the response status

    • info

      removed the KAFKA_CLUSTER_CONNECTION enum value from the response property for the response status