Xeonr Developer Docs

Delete Cluster

POST
/containers.api.v1.ClusterService/DeleteCluster

Deletes a cluster record and revokes its enrolment tokens. Fails with FailedPrecondition while any namespace is placed on it unless force is set, and always for the default cluster. A connected operator loses its credential on its next heartbeat.

Access: admin of the owner team, or a platform admin. Other callers get NotFound.

Authorization

BearerAuth
AuthorizationBearer <token>

A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC token for humans. The key's namespace and role are pinned server-side.

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

clusterId?string
Match^cl-[0-9a-f]{16}$
force?boolean

Delete even while namespaces are placed on the cluster. Their records stay, pointing at a cluster that no longer exists, until each is deleted. validate:skip a bool has no bounds

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.ClusterService/DeleteCluster" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}