List Kubernetes clusters
The organization's managed Kubernetes clusters, newest first, in cursor pages of summaries with each cluster's status, health, and node and Ready counts. 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 cluster listapiKeyAuthorizationBearer <token>OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).
limit?integerItems per page.
1 <= value <= 10020cursor?stringPage of clusters
application/json- response
items*array<>nextCursor?stringOpaque; pass back to continue. Absent means no more pages.
curl -X GET 'https://api.openrelay.inc/v1/kubernetes/clusters'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "status": "creating", "health": "healthy", "kubernetesVersion": "string", "workerCount": 0, "healthyWorkerCount": 0, "createdAt": "string" } ], "nextCursor": "string"}Overview
Managed Kubernetes: clusters whose control plane we run, with whole GPU or CPU hosts as nodes. Create clusters, scale node pools, and get kubeconfigs. Managed Kubernetes is in limited availability and is enabled per organization; without it every operation answers 409 FEATURE_DISABLED. Every operation acts in the caller's own organization: the API key's, or the session's X-Org-Id. The server checks every request against the parameters and request bodies documented here and answers 400 BAD_REQUEST naming the violation, so each constraint is enforced as written. A 409 INVALID_CLUSTER_STATE names the cluster status that blocks the operation.
Create a Kubernetes cluster POST
Starts creating a cluster with a managed control plane in one data center and answers 202 with its id; poll getKubernetesCluster for its status. Node pools in the request are added once the control plane is ready; add more later with createKubernetesNodePool. A cluster's name is unique within the organization: a create with the name of one of its clusters answers 409 NAME_TAKEN until that cluster's deletion completes. An organization has a configured limit on clusters creating at once; a create at that limit answers 409 TOO_MANY_CLUSTERS_CREATING until one of them leaves creating. A create that meets a concurrent change to the organization answers 409 CONCURRENT_UPDATE; retry it. A legacy API key needs clusters:write.