Xeonr Developer Docs
API Specificationcontainers.api.v1.ClusterService

Get Cluster

POST
/containers.api.v1.ClusterService/GetCluster

Returns a cluster record. A cluster the caller cannot see is reported as NotFound.

Access: a member of the owner team or of a team holding a grant, any caller for a GLOBAL cluster, a namespace API key for the cluster its namespace is placed on, or a platform admin.

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/GetCluster" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cluster": {
    "clusterId": "string",
    "displayName": "string",
    "ownerTeam": "string",
    "visibility": "CLUSTER_VISIBILITY_UNSPECIFIED",
    "grants": [
      {
        "team": "string",
        "quotaCpuMillis": 0,
        "quotaMemoryMb": 0,
        "quotaMaxPods": 0,
        "quotaStorageMb": 0,
        "quotaMaxVolumes": 0
      }
    ],
    "default": true,
    "allowRunc": true,
    "state": "CLUSTER_STATE_UNSPECIFIED",
    "lastSeen": "2023-01-15T01:30:15.01Z",
    "operatorVersion": "string",
    "capabilities": {
      "gvisor": true,
      "cpCsi": true,
      "previewIngress": true,
      "appIngress": true,
      "previewDomain": "string",
      "appDomain": "string"
    },
    "labels": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "2023-01-15T01:30:15.01Z",
    "capacity": {
      "observedAt": "2023-01-15T01:30:15.01Z",
      "nodes": [
        {
          "name": "string",
          "ready": true,
          "allocatableCpuMillis": "string",
          "allocatableMemoryMb": "string",
          "allocatablePods": 0,
          "requestedCpuMillis": "string",
          "requestedMemoryMb": "string",
          "pods": 0,
          "volumeDiskFreeMb": "string"
        }
      ],
      "installCap": {
        "cpuMillis": "string",
        "memoryMb": "string",
        "pods": 0,
        "storageMb": "string",
        "volumes": 0
      },
      "installRequested": {
        "cpuMillis": "string",
        "memoryMb": "string",
        "pods": 0,
        "storageMb": "string",
        "volumes": 0
      }
    },
    "conditions": [
      {
        "type": "TYPE_UNSPECIFIED",
        "message": "string",
        "since": "2023-01-15T01:30:15.01Z",
        "pods": [
          "string"
        ]
      }
    ],
    "archiveIntervalSec": 0,
    "archivedBytes": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

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.

List Clusters POST

Lists the clusters visible to the caller, ordered by display name: those owned by a team they are in, those granting such a team, and every GLOBAL cluster (all of them for a platform admin; for a namespace API key, the clusters its namespaces are placed on). With `team` set, only the clusters that team owns or may place a namespace on; a team the caller is not in is NotFound. `limit` 0 means 50 and is at most 500; `cursor` is opaque, from `next_cursor`. **Access:** any authenticated caller; results are filtered to what the caller can see.