Skip to main content
PATCH
/
clusters
/
{id}
Update cluster
curl --request PATCH \
  --url https://api.akua.dev/v1/clusters/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "name": "<string>",
  "region_id": "<string>",
  "kubeconfig": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "workspace_id": "<string>",
  "reconciling": true,
  "created_at": 1,
  "updated_at": 1,
  "etag": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://akua-1dce587a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

​
akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

​
idempotency-key
string

Caller-supplied idempotency key. Repeated requests with the same key return the existing resource instead of creating a duplicate. Safe to retry after a timed-out or interrupted request.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

​
if-match
string
required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256
Example:

"42"

Path Parameters

​
id
string
required
Required string length: 1 - 54

Body

application/json
​
name
string
Required string length: 1 - 100
​
region_id
string
Required string length: 1 - 54
​
provider
enum<string>

Cluster control-plane family: managed (managed_kaas) vs imported self-managed (imported_byoc).

Available options:
managed_kaas,
imported_byoc
​
kubeconfig
string
Minimum string length: 1

Response

Cluster updated

​
id
string
required
Required string length: 1 - 54
​
name
string
required
​
workspace_id
string
required
Required string length: 1 - 53
​
state
enum<string>
required

Cluster lifecycle state in canonical lowercase, past-participle naming.

Available options:
pending,
provisioning,
active,
suspended,
deleting
​
provider
enum<string>
required

Cluster control-plane family: managed (managed_kaas) vs imported self-managed (imported_byoc).

Available options:
managed_kaas,
imported_byoc
​
reconciling
boolean
required
​
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
etag
string
required