Skip to main content
GET
Get cluster

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"

Path Parameters

id
string
required

Cluster ID.

Required string length: 1 - 54

Response

Cluster details

id
string
required
Required string length: 1 - 54
html_url
string<uri>
required

Absolute dashboard URL for this resource. OUTPUT_ONLY.

Maximum string length: 2048
Example:

"https://akua.dev/clusters/clu_j572abc123def456"

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