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 node pools

Returns a cluster's node pools as a cursor-paginated page, each with its SKU, the node count it converges to, how many nodes are Ready, and its status. 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-pool list <id>
GET
/v1/kubernetes/clusters/{id}/node-pools

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

Response Body

Page of node pools

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/node-pools'
Example Response
{  "items": [    {      "id": "string",      "clusterId": "string",      "name": "string",      "sku": {        "gpuModelId": "string"      },      "count": 0,      "readyCount": 0,      "status": "creating",      "createdAt": "string"    }  ],  "nextCursor": "string"}

Delete a Kubernetes cluster DELETE

Starts deleting the cluster, its node pools and every node, and answers 202; poll getKubernetesCluster, which answers 404 once deletion completes. Deletion is final: the cluster's state is not kept. Repeating the call finishes a deletion that could not remove everything. A legacy API key needs clusters:write.

Add a node pool to a cluster POST

Adds count whole-host nodes of one SKU, a GPU model or a whole-host CPU SKU, in the cluster's data center, and answers 202 with the new pool as creating. 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.