Xeonr Developer Docs
API Specificationcontainers.api.v1.ClusterService

Create Enrolment Token

POST
/containers.api.v1.ClusterService/CreateEnrolmentToken

Mints a one-time enrolment token for a cluster, valid for 15 minutes, which an operator install exchanges for its cluster credential on first start. The secret is returned exactly once. Minting a new token does not revoke an unspent earlier one until it expires.

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}$
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.ClusterService/CreateEnrolmentToken" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "enrolmentTokenSecret": "string",
  "expiresAt": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Create Cluster POST

Registers a cluster owned by `owner_team` in PENDING state with PRIVATE visibility. Nothing runs on it until an operator enrols (CreateEnrolmentToken, then the operator's first connection). A platform admin's `owner_team` is verified against Xeonr Auth and canonicalised to the team URN. **Access:** a platform admin, or an admin of the `owner_team` team.

Delete Cluster POST

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.