Skip to main content
GET
/
api
/
v1
/
clusters
/
{name}
Get Cluster
curl --request GET \
  --url https://api.example.com/api/v1/clusters/{name}
{
  "apiVersion": "v1",
  "kind": "ClusterRegistration",
  "metadata": {
    "name": "production-us-east-1",
    "namespace": "chatcli-system",
    "createdAt": "2026-01-15T10:00:00Z"
  },
  "spec": {
    "displayName": "Production US East 1",
    "kubeconfigSecret": "cluster-prod-us-east-1-kubeconfig",
    "tier": "production",
    "region": "us-east-1"
  },
  "status": {
    "phase": "Connected",
    "lastHealthCheck": "2026-03-19T15:00:00Z",
    "kubernetesVersion": "v1.31.2",
    "nodeCount": 12,
    "namespaceCount": 25,
    "activeIssues": 2,
    "activeRemediations": 1,
    "resourceUsage": {
      "cpuCapacity": "48",
      "cpuUsed": "31.2",
      "memoryCapacity": "192Gi",
      "memoryUsed": "124Gi"
    }
  }
}
​
name
string
required
Unique cluster registration name
​
namespace
string
default:"default"
Kubernetes namespace where the ClusterRegistration CR resides
{
  "apiVersion": "v1",
  "kind": "ClusterRegistration",
  "metadata": {
    "name": "production-us-east-1",
    "namespace": "chatcli-system",
    "createdAt": "2026-01-15T10:00:00Z"
  },
  "spec": {
    "displayName": "Production US East 1",
    "kubeconfigSecret": "cluster-prod-us-east-1-kubeconfig",
    "tier": "production",
    "region": "us-east-1"
  },
  "status": {
    "phase": "Connected",
    "lastHealthCheck": "2026-03-19T15:00:00Z",
    "kubernetesVersion": "v1.31.2",
    "nodeCount": 12,
    "namespaceCount": 25,
    "activeIssues": 2,
    "activeRemediations": 1,
    "resourceUsage": {
      "cpuCapacity": "48",
      "cpuUsed": "31.2",
      "memoryCapacity": "192Gi",
      "memoryUsed": "124Gi"
    }
  }
}

{
  "apiVersion": "v1",
  "kind": "Error",
  "error": {
    "code": 404,
    "message": "Cluster not found",
    "details": "No cluster registration named 'production-us-east-1' found"
  }
}