GRgravitee-io
Clusters

Create a cluster

Changed on

User must have the ENVIRONMENT_CLUSTER[CREATE] permission.

post/clusters

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

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.

Changes

  • ac9b3975b952Revision changes
    • warning

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

    • info

      added the new KAFKA_VIRTUAL_CLUSTER enum value to the request property

  • 86ed32989ff4Revision changes
    • breaking

      removed the enum value KAFKA_CLUSTER_CONNECTION of the request property

    • warning

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

    • info

      added the new KAFKA_CLUSTER_STANDALONE enum value to the request property

    • info

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