Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeKubernetes

List a cluster's nodes

Returns a cluster's nodes as a cursor-paginated page, each with its pool, registration state and Ready condition; filter to one pool with nodePoolId. A legacy API key needs clusters:read.

Required permission

Requires the kubernetes.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl kube node list <id>
GET
/v1/kubernetes/clusters/{id}/nodes

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

id*string

Query Parameters

limit?integer

Items per page.

Range1 <= value <= 100
Default20
cursor?string
nodePoolId?string

Only the nodes of this pool.

Response Body

Page of nodes

application/json
  1. response
items*array<>
nextCursor?string

Opaque; pass back to continue. Absent means no more pages.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/kubernetes/clusters/string/nodes'
Example Response
{  "items": [    {      "id": "string",      "nodePoolId": "string",      "registrationStatus": "registered",      "kubernetesStatus": "Ready"    }  ],  "nextCursor": "string"}

Scale a node pool POST

Sets the pool's node count and answers 202 with the pool. Scaling down removes nodes and whatever runs on them, draining each one first. A cluster that is creating, deleting or failed answers 409 INVALID_CLUSTER_STATE; a failed cluster has no control plane to join. A legacy API key needs clusters:write.

Get a node GET

Returns one node of the cluster: its registration and Ready state, its name in the cluster once it joins, the host's public IP and, on a GPU host, its GPUs. A legacy API key needs clusters:read.