Xeonr Developer Docs
API Specificationcontainers.api.v1.TeamSettingsService

Get Team Settings

POST
/containers.api.v1.TeamSettingsService/GetTeamSettings

Returns a team's settings. A team the caller is not in is NotFound — which, for a namespace API key, is every team. A team with nothing set yet returns empty settings, not an error.

Access: any member of the team, 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

team?string
Match^urn:xeonr:auth:team:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
[key: string]?never

Response Body

application/json

application/json

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

containers.api.v1.TeamSettingsService

TeamSettingsService holds a team's container-platform preferences. Teams themselves live in Xeonr Auth; this is only what the platform remembers about one.

Set Team Default Cluster POST

Sets, or with an empty `cluster_id` clears, the cluster a namespace created for this team is placed on when the request names none. The team must be able to place on the cluster (it owns it, holds a grant, or the cluster is GLOBAL); otherwise PermissionDenied. With it cleared, the platform's default cluster applies. **Access:** an admin of the team, or a platform admin.