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

Delete a Kubernetes cluster

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl kube cluster delete <id>
DELETE
/v1/kubernetes/clusters/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

Deletion started

application/json
  1. response

A cluster create or delete was accepted: the cluster's id and its status, creating or deleting. Poll getKubernetesCluster, which answers 404 once a deletion completes.

id*string
Formatuuid
status*KubernetesClusterStatus

creating: the control plane is being provisioned, and stays creating until it is serving and authorizes the platform's own writes. ready: fully operational. updating: a control-plane change is in progress. degraded: partially operational, for example the control plane stopped serving or its datastore is write-limited. deleting: deletion is in progress and final. failed: an unrecoverable error.

Value in"creating""ready""updating""degraded""deleting""failed"
Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/kubernetes/clusters/string'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "creating"}

Get a Kubernetes cluster GET

Returns one cluster: its status, Kubernetes version, data center, control-plane replicas, API endpoint, pod and service networks, node counts and conditions. A legacy API key needs clusters:read.

List a cluster's node pools GET

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.