Xeonr Developer Docs
API SpecificationNamespaces

Get Namespace

POST
/containers.api.v1.NamespaceService/GetNamespace

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

Access: any role in the namespace, 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

namespace?string
Length1 <= length <= 64
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.NamespaceService/GetNamespace" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "namespace": {
    "namespace": "string",
    "displayName": "string",
    "k8sRunnerNamespace": "string",
    "groups": [
      {
        "oidcGroup": "string",
        "role": "ROLE_UNSPECIFIED"
      }
    ],
    "defaultLimits": {
      "cpuMillis": 0,
      "memoryMb": 0,
      "ephemeralMb": 0,
      "pids": 0
    },
    "quotaCpuMillis": 0,
    "quotaMemoryMb": 0,
    "quotaMaxPods": 0,
    "quotaStorageMb": 0,
    "quotaMaxVolumes": 0,
    "internalTargets": [
      {
        "host": "string",
        "port": 1
      }
    ],
    "imagePullSecrets": [
      "string"
    ],
    "ownerTeam": "string",
    "clusterId": "string",
    "move": {
      "state": "STATE_UNSPECIFIED",
      "sourceClusterId": "string",
      "targetClusterId": "string",
      "startedAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "finishedAt": "2023-01-15T01:30:15.01Z",
      "message": "string",
      "rolledBack": true,
      "estimatedDowntimeSec": 0,
      "volumes": [
        {
          "volumeId": "string",
          "archiveSnapshotId": "string",
          "sourceNode": "string",
          "sourceState": "VOLUME_STATE_UNSPECIFIED",
          "reseeded": true
        }
      ],
      "startedBy": "string"
    }
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Delete Namespace POST

Tears down the namespace's runner namespace, deletes the record and revokes every API key owned by or bound to it. Fails with FailedPrecondition while the namespace still has API keys unless `force` is set. **Access:** admin role in the namespace (the owning team's admins, or an ADMIN-role namespace API key), or a platform admin. Other callers get NotFound.

Issue API Key POST

Issues a machine API key owned by this namespace with `role` (UNSPECIFIED means OPERATOR): a Xeonr Auth API key bound to the namespace, and with `workspace_ids` set, confined to those workspaces as well. `expires_at_unix` sets when it stops working (0: never). The plaintext (`xk_…`) is returned once and never again. A key issued before keys moved to Xeonr Auth (`cpk_…`) keeps working unchanged. Keys never carry platform-admin rights. **Access:** admin role in the namespace (the owning team's admins, or an ADMIN-role namespace API key), or a platform admin. Other callers get NotFound.