Sign in

v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22216424765.0 KB
gateway.openapi_Gateway

Update Cluster

patch/v1/accounts/{account_id}/clusters/{cluster_id}

Path parameters

account_idstring required

The Account Id

cluster_idstring required

The Cluster Id

Request body

displayNamestring

Human-readable display name of the cluster. e.g. "My Cluster" Must be fewer than 64 characters long.

createTimestring date-time

The creation time of the cluster.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The cluster is ready to be used.
  • DELETING: The cluster is being deleted.
  • FAILED: Cluster is not operational. Consult 'status' for detailed messaging. Cluster needs to be deleted and re-created.
updateTimestring date-time

The update time for the cluster.

Response

A successful response.

namestring
displayNamestring

Human-readable display name of the cluster. e.g. "My Cluster" Must be fewer than 64 characters long.

createTimestring date-time

The creation time of the cluster.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The cluster is ready to be used.
  • DELETING: The cluster is being deleted.
  • FAILED: Cluster is not operational. Consult 'status' for detailed messaging. Cluster needs to be deleted and re-created.
updateTimestring date-time

The update time for the cluster.