Skip to main content
GET
List nodes

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

Query Parameters

cursor
string
Maximum string length: 512
limit
integer
Required range: 1 <= x <= 100
node_pool_id
string

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

Nodes, by name

data
object[]
required
Maximum array length: 500
has_more
boolean
required
next_cursor
string | null
required
Maximum string length: 512