Clusters
Retrieve a cluster
Returns the Cluster record with its server-derived health_status. For detailed telemetry (node counts, resource usage, workload summary), use GetClusterStatus instead.
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 unique identifier of the cluster (UUID).
Format
uuidResponse Body
application/json
curl -X GET "https://admiral.example.com/api/v1/clusters/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "cluster": { "id": "c3d4e5f6-7890-1abc-def0-abcdef012345", "name": "prod-us-east-1", "description": "Primary production cluster serving US East traffic.", "labels": { "region": "us-east-1", "cloud": "aws", "tier": "production" }, "cluster_uid": "kube-system-uid-9f8e7d6c", "health_status": "CLUSTER_HEALTH_STATUS_HEALTHY", "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-06-10T08:00:00Z", "updated_at": "2025-11-20T16:45:00Z" }}