Suspend cluster
Suspends a running cluster. The API returns an Operation envelope because teardown and drain are asynchronous.
Authorizations
workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens
Headers
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.
1 - 53"ws_j572abc123def456"
Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.
1 - 64"create-prod-2026-05-07"
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.
1 - 256"42"
Path Parameters
1 - 54Response
Suspend initiated
1 - 531 - 531 - 54Domain entity collection the operation acts on.
install, repository_change_request, repository, workspace, machine, cluster, package Prefixed ID of the entity this operation acts on. Prefix matches owner_type (ws_, mch_, clu_, pkg_, inst_, rcr_, repo_).
ID of the chained parent operation, when present.
1 - 53Lifecycle state. Past-participle terminal states per AIP-216.
RUNNING, SUCCEEDED, FAILED, CANCELLED True iff state is a terminal value.
Deep link to the dashboard view of this operation's owning resource when available, otherwise the operation detail page.
2048"https://akua.dev/installs/inst_j572abc123def456?tab=operations"
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
Populated only when done && state === "SUCCEEDED". Discriminated by type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
Populated when state is FAILED or CANCELLED.
Latest error from any failed step. Populated even mid-flight; cleared when the step succeeds on retry.
Unix timestamp (seconds)
x >= 0Unix timestamp (seconds)
x >= 0