Skip to main content
GET
Get a node pool

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

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_j572abc123def4"

Path Parameters

id
string
required
Required string length: 3 - 54
node_pool_id
string
required

A DNS label of at most 40 characters, unique in the Cluster. Every node of the pool carries it as the label akua.dev/node-pool.

Pattern: ^[a-z](?:[-a-z0-9]{0,38}[a-z0-9])?$
Example:

"default"

Response

The node pool

id
string
required

A DNS label of at most 40 characters, unique in the Cluster. Every node of the pool carries it as the label akua.dev/node-pool.

Pattern: ^[a-z](?:[-a-z0-9]{0,38}[a-z0-9])?$
Example:

"default"

cluster_id
string
required
Required string length: 3 - 54
workspace_id
string
required
Required string length: 2 - 53
html_url
string<uri>
required
Maximum string length: 2048
machine_type
string
required
Pattern: ^[a-z][a-z0-9-]{0,31}$
Example:

"cx23"

locations
string[]
required

Where the pool places its Machines in the Cluster’s Region; empty lets Akua choose. One location at launch.

Maximum array length: 1
Pattern: ^[a-z][a-z0-9-]{1,31}$
image
enum<string>
required
Available options:
ubuntu-24.04
labels
object
required
Example:
node_count
integer
required

Number of nodes the pool keeps, 0 to 10 at launch.

Required range: 0 <= x <= 10
ready_nodes
integer
required
Required range: x >= 0
state
enum<string>
required

provisioning: its first nodes are being created and joined. ready: every node is ready. resizing: nodes are being added or removed after a size change. degraded: some nodes are not ready or could not be created; see conditions. failed: no node could be created; see conditions. deleting: its nodes are drained and their Machines deleted.

Available options:
provisioning,
ready,
resizing,
degraded,
failed,
deleting,
deleted
conditions
object[]
required

What needs attention now; empty when nothing does. Reasons:

  • billing-required (error or warning): the Workspace has no active billing account, so no Machine was created. Remedy add-billing.
  • quota-exceeded (error or warning): the Workspace or your trial has no Machine capacity left. Remedy free-capacity or upgrade-plan.
  • capacity-unavailable, provider-refused, provider-unavailable (error or warning): a Machine of the pool could not be created; the message names the node. Forwarded from the Machine.
  • join-timeout (warning): a server started but its node never became ready; its Machine was deleted.
  • nodes-not-ready (warning): Kubernetes reports nodes of the pool not ready; the message names them.
  • trial-ended (warning): the free trial Machine of a node was paused and its node removed. Remedy add-billing, then set the size again.
  • machine-deleted (warning): a node’s Machine was deleted outside the pool; the node is gone and the pool is smaller than node_count.
  • drain-timeout (warning): Pods did not leave a removed node within the drain bound; it was removed anyway.
  • abandoned (error): the create request ended before it recorded its Machines; what it created was deleted. An error holds while state is failed; the same reason is a warning when other nodes run.
Maximum array length: 32
operation_id
string
required
Required string length: 2 - 192
created_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
updated_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
etag
string
required
Maximum string length: 64