Skip to navigation

Get a node

View as Markdown

Returns one node. Control-plane nodes do not belong to a node pool, so their nodePoolID and nodeSetID are the nil UUID. nico is omitted when none of its fields are set.

Authentication

AuthorizationBearer

A JWT from an issuer the Operator has configured, carried as Authorization: Bearer <token>.

Path parameters

nodeIDstringRequiredformat: "uuid"
Node ID.

Response

The requested node
idstringformat: "uuid"
Node ID.
nodePoolIDstringformat: "uuid"

Owning node pool. The nil UUID for control-plane nodes.

nodeSetIDstringformat: "uuid"

Owning NodeSet. The nil UUID for control-plane nodes.

namestring
Node name.
controlPlaneboolean

Whether the node is a control-plane node.

conditionsobject
Lifecycle and health conditions.
ipstringOptionalformat: "ipv4"
Node IP address.
nicoobjectOptional
NICo instanceID, machineID and instanceTypeID. Omitted when none are set.
launchLayerobjectOptional
LaunchLayer instanceID, machineID and rackID. Omitted when none are set.
controlPlaneRolloutobjectOptional

Control-plane nodes only.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error