Skip to main content
PATCH
/
v1
/
clusters
/
{id}
Update cluster
curl --request PATCH \
  --url https://api.cnap.tech/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "staging",
  "region_id": "<string>"
}
'
{
  "id": "j572abc123def456",
  "name": "production",
  "workspace_id": "j572abc123def456",
  "region_id": "j572abc123def456",
  "kaas": {
    "version": "v1.30",
    "status": "RUNNING",
    "status_message": null
  },
  "created_at": 123
}

Authorizations

​
Authorization
string
header
required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://dash.cnap.tech/account/tokens

Path Parameters

​
id
string
required

Cluster ID

Body

application/json
​
name
string
Required string length: 1 - 100
Example:

"staging"

​
region_id
string

Region ID

Response

Updated cluster

​
id
string
required
Example:

"j572abc123def456"

​
name
string
required
Example:

"production"

​
workspace_id
string
required
Example:

"j572abc123def456"

​
region_id
string
required
Example:

"j572abc123def456"

​
kaas
object
required

Present if cluster is KaaS-managed

​
created_at
number
required

Unix timestamp (seconds)