Admiral
Clusters

Retrieve a cluster token

GET
/api/v1/clusters/{cluster_id}/tokens/{token_id}

Scope: cluster:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...

In: header

Path Parameters

cluster_id*cluster_id

The cluster the token belongs to (UUID).

Formatuuid
token_id*token_id

The unique identifier of the token (UUID).

Formatuuid

Response Body

application/json

curl -X GET "https://admiral.example.com/api/v1/clusters/497f6eca-6276-4993-bfeb-53cbbbba6f08/tokens/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "access_token": {    "id": "9f8e7d6c-5b4a-3210-fedc-ba0987654321",    "name": "ci-deploy-key",    "token_type": "TOKEN_TYPE_PAT",    "scopes": [      "deploy:write",      "app:read",      "env:read"    ],    "status": "ACCESS_TOKEN_STATUS_ACTIVE",    "binding_type": "BINDING_TYPE_USER",    "binding_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "expires_at": "2026-06-01T00:00:00Z",    "last_used_at": "2025-11-20T14:30:00Z",    "created_at": "2025-09-01T10:00:00Z"  }}

Retrieve cluster status GET

Returns NOT_FOUND if the cluster does not exist. If the cluster exists but no agent has reported telemetry yet, the response will have health_status PENDING and no status message. Scope: `cluster:read`

List clusters GET

Scope: `cluster:read`