Skip to main content
GET
/
federation
/
clusters
Federation Clusters
curl --request GET \
  --url http://{host}:{port}/{basePath}/federation/clusters \
  --header 'Authorization: <api-key>'
{
  "apiVersion": "v1",
  "kind": "ClusterRegistrationList",
  "metadata": {
    "totalCount": 3,
    "page": 1,
    "pageSize": 3
  },
  "items": [
    {
      "name": "production-us-east-1",
      "namespace": "chatcli-system",
      "displayName": "Production US East 1",
      "tier": "critical",
      "region": "us-east-1",
      "connected": true,
      "version": "v1.31.2",
      "nodeCount": 12,
      "activeIssues": 2,
      "lastHealthCheck": "2026-03-22T15:00:00Z",
      "creationTimestamp": "2026-01-15T10:00:00Z"
    }
  ]
}
​
tier
string
Filter by cluster tier: critical, standard, non-critical
{
  "apiVersion": "v1",
  "kind": "ClusterRegistrationList",
  "metadata": {
    "totalCount": 3,
    "page": 1,
    "pageSize": 3
  },
  "items": [
    {
      "name": "production-us-east-1",
      "namespace": "chatcli-system",
      "displayName": "Production US East 1",
      "tier": "critical",
      "region": "us-east-1",
      "connected": true,
      "version": "v1.31.2",
      "nodeCount": 12,
      "activeIssues": 2,
      "lastHealthCheck": "2026-03-22T15:00:00Z",
      "creationTimestamp": "2026-01-15T10:00:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token issued by the operator. Format: Authorization: Bearer <token>.

Query Parameters

​
tier
enum<string>

Filter by cluster tier.

Available options:
critical,
standard,
non-critical

Response

Federated cluster list

​
apiVersion
string
Example:

"v1"

​
kind
string
Example:

"ClusterRegistrationList"

​
metadata
object
​
items
object[]