Skip to main content
GET
/
api
/
v1
/
clusters
List Clusters
curl --request GET \
  --url https://api.example.com/api/v1/clusters
{
  "apiVersion": "v1",
  "kind": "ClusterList",
  "metadata": {
    "totalCount": 4
  },
  "items": [
    {
      "name": "prod-sa-east-1",
      "region": "sa-east-1",
      "provider": "aws",
      "version": "1.29.2",
      "status": "healthy",
      "nodes": {
        "total": 12,
        "ready": 12
      },
      "incidents": {
        "active": 2,
        "total24h": 5
      },
      "resources": {
        "cpuUsagePercent": 62,
        "memoryUsagePercent": 71,
        "podCount": 245,
        "podCapacity": 360
      },
      "lastHeartbeat": "2026-03-19T15:29:00Z",
      "connectedAt": "2026-01-05T10:00:00Z"
    },
    {
      "name": "prod-us-east-1",
      "region": "us-east-1",
      "provider": "aws",
      "version": "1.29.2",
      "status": "healthy",
      "nodes": {
        "total": 8,
        "ready": 8
      },
      "incidents": {
        "active": 0,
        "total24h": 1
      },
      "resources": {
        "cpuUsagePercent": 45,
        "memoryUsagePercent": 55,
        "podCount": 180,
        "podCapacity": 240
      },
      "lastHeartbeat": "2026-03-19T15:29:00Z",
      "connectedAt": "2026-01-05T10:00:00Z"
    },
    {
      "name": "staging-sa-east-1",
      "region": "sa-east-1",
      "provider": "aws",
      "version": "1.30.0",
      "status": "degraded",
      "nodes": {
        "total": 4,
        "ready": 3
      },
      "incidents": {
        "active": 1,
        "total24h": 3
      },
      "resources": {
        "cpuUsagePercent": 78,
        "memoryUsagePercent": 82,
        "podCount": 95,
        "podCapacity": 120
      },
      "lastHeartbeat": "2026-03-19T15:28:30Z",
      "connectedAt": "2026-02-01T14:00:00Z"
    }
  ]
}
​
status
string
Filter by status: healthy, degraded, unreachable
​
region
string
Filter by region (e.g., us-east-1, sa-east-1)
{
  "apiVersion": "v1",
  "kind": "ClusterList",
  "metadata": {
    "totalCount": 4
  },
  "items": [
    {
      "name": "prod-sa-east-1",
      "region": "sa-east-1",
      "provider": "aws",
      "version": "1.29.2",
      "status": "healthy",
      "nodes": {
        "total": 12,
        "ready": 12
      },
      "incidents": {
        "active": 2,
        "total24h": 5
      },
      "resources": {
        "cpuUsagePercent": 62,
        "memoryUsagePercent": 71,
        "podCount": 245,
        "podCapacity": 360
      },
      "lastHeartbeat": "2026-03-19T15:29:00Z",
      "connectedAt": "2026-01-05T10:00:00Z"
    },
    {
      "name": "prod-us-east-1",
      "region": "us-east-1",
      "provider": "aws",
      "version": "1.29.2",
      "status": "healthy",
      "nodes": {
        "total": 8,
        "ready": 8
      },
      "incidents": {
        "active": 0,
        "total24h": 1
      },
      "resources": {
        "cpuUsagePercent": 45,
        "memoryUsagePercent": 55,
        "podCount": 180,
        "podCapacity": 240
      },
      "lastHeartbeat": "2026-03-19T15:29:00Z",
      "connectedAt": "2026-01-05T10:00:00Z"
    },
    {
      "name": "staging-sa-east-1",
      "region": "sa-east-1",
      "provider": "aws",
      "version": "1.30.0",
      "status": "degraded",
      "nodes": {
        "total": 4,
        "ready": 3
      },
      "incidents": {
        "active": 1,
        "total24h": 3
      },
      "resources": {
        "cpuUsagePercent": 78,
        "memoryUsagePercent": 82,
        "podCount": 95,
        "podCapacity": 120
      },
      "lastHeartbeat": "2026-03-19T15:28:30Z",
      "connectedAt": "2026-02-01T14:00:00Z"
    }
  ]
}