Skip to main content
PATCH
/
cluster
/
edit
/
{cluster}
Edit a cluster
curl --request PATCH \
  --url https://api.example.com/cluster/edit/{cluster} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cluster_name": "renamed-cluster",
  "deletion_protection": true
}
'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
cluster
string
required

Body

application/json

Request model for editing a cluster.

​
cluster_name
string | null

New name for the cluster. Must be unique within user/org scope.

Example:

"renamed-cluster"

​
deletion_protection
boolean | null

Update deletion protection setting. Set to true to protect cluster from accidental deletion, or false to allow deletion. Must be disabled before cluster can be destroyed.

Example:

true

Response

Successful Response

Response model for edit endpoints (cluster and storage).

​
message
string
required