Skip to main content
GET
Get a node

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
name
string
required
Required string length: 1 - 253
Pattern: ^[a-z0-9](?:[-a-z0-9.]*[a-z0-9])?$

Response

The node

name
string
required
Required string length: 1 - 253
Pattern: ^[a-z0-9](?:[-a-z0-9.]*[a-z0-9])?$
cluster_id
string
required
Required string length: 3 - 54
source
object
required
state
enum<string>
required

provisioning: its Machine is being created or its server is joining. ready: joined; Kubernetes readiness is ready and conditions. draining: cordoned and evicting Pods before it is removed. deleted: removed from the Cluster.

Available options:
provisioning,
restoring,
ready,
draining,
deleted
conditions
object[]
required

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

  • not-ready (warning): Kubernetes reports the node not ready.
  • join-timeout (error): the server started but never joined; its Machine was deleted.
  • drain-timeout (warning): Pods did not leave within the drain bound; the node was removed anyway.
  • trial-ended (warning): the node’s free trial Machine was paused. Remedy add-billing.
  • capacity-unavailable, provider-refused, provider-unavailable (error): its Machine could not be created; forwarded from the Machine.
Maximum array length: 32
ready
boolean
required

Kubernetes Ready; false until the node joined.

provider_id
string | null
required

The node's spec.providerID; null without a cloud controller.

Maximum string length: 256
labels
object
required
kubelet_version
string | null
required
Maximum string length: 64
created_at
integer | null
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991