Clusters API
List Kubernetes clusters, get cluster details, view dashboard metrics, and retrieve cost distribution breakdowns. Includes curl examples and response schemas.
Cluster endpoints return metadata, utilization, and cost data for the Kubernetes clusters connected to your organization.
Required scope: clusters:read
List Clusters
text
GET /v1/clustersReturns a paginated list of all clusters in your organization.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 100 | Number of results to return (1 to 500) |
offset | integer | 0 | Number of results to skip |
Example Request
bash
curl -H "Authorization: Bearer ka_your_api_key" \
"https://public-api.kubeadapt.io/v1/clusters?limit=10&offset=0"Example Response
json
{
"clusters": [
{
"id": "cls-abc123",
"name": "prod-us-east",
"provider": "aws",
"region": "us-east-1",
"environment": "production",
"status": "active",
"version": "1.35.0",
"node_count": 10,
"pod_count": 250,
"cpu_cores": 40.0,
"memory_gb": 160.0,
"cpu_utilization_percent": 45.5,
"memory_utilization_percent": 62.3,
"hourly_cost": 125.5,
"efficiency_score": 0.78,
"monthly_cost": 91615.0,
"potential_monthly_savings": 15000.0,
"recommendation_count": 5
}
],
"total": 3
}Get Cluster
text
GET /v1/clusters/{cluster_id}Returns a single cluster by ID.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
cluster_id | string | Yes | Cluster ID |
Example Request
bash
curl -H "Authorization: Bearer ka_your_api_key" \
https://public-api.kubeadapt.io/v1/clusters/cls-abc123Example Response
json
{
"id": "cls-abc123",
"name": "prod-us-east",
"provider": "aws",
"region": "us-east-1",
"environment": "production",
"status": "active",
"version": "1.35.0",
"node_count": 10,
"pod_count": 250,
"cpu_cores": 40.0,
"memory_gb": 160.0,
"cpu_utilization_percent": 45.5,
"memory_utilization_percent": 62.3,
"hourly_cost": 125.5,
"efficiency_score": 0.78,
"monthly_cost": 91615.0,
"potential_monthly_savings": 15000.0,
"recommendation_count": 5
}Cluster Dashboard
text
GET /v1/clusters/{cluster_id}/dashboardReturns detailed dashboard metrics for a cluster, including cost breakdown, resource utilization, and recommendation summary.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
cluster_id | string | Yes | Cluster ID |
Example Request
bash
curl -H "Authorization: Bearer ka_your_api_key" \
https://public-api.kubeadapt.io/v1/clusters/cls-abc123/dashboardExample Response
json
{
"cluster_id": "cls-abc123",
"cluster_name": "prod-us-east",
"provider": "aws",
"region": "us-east-1",
"environment": "production",
"status": "active",
"version": "1.35.0",
"node_count": 10,
"pod_count": 250,
"container_count": 480,
"deployment_count": 42,
"namespace_count": 8,
"hourly_cost": 125.5,
"monthly_cost": 91615.0,
"total_savings_hourly": 20.55,
"monthly_savings": 15001.5,
"cpu_cores": 40.0,
"cpu_usage": 18.2,
"cpu_utilization_percent": 45.5,
"memory_gb": 160.0,
"memory_usage_gb": 99.7,
"memory_utilization_percent": 62.3,
"cluster_efficiency": 0.78,
"recommendation_count": 5,
"cost_breakdown": {
"cpu_cost": 85.0,
"memory_cost": 20.0,
"storage_cost": 15.0,
"gpu_cost": 0.0
},
"mtd_actual_cost": 42500.0,
"potential_monthly_savings": 15000.0,
"recommendation_summary": [
{ "type": "workload_rightsizing", "count": 2, "potential_savings": 1460.0 }
]
}Cost Distribution
text
GET /v1/clusters/{cluster_id}/cost-distributionReturns time-series cost and utilization data for a cluster over a given timeframe.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
cluster_id | string | Yes | Cluster ID |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
timeframe | string | 7d | Time window. Valid values: 1h, 24h, 7d, 30d, 90d, 360d |
Example Request
bash
curl -H "Authorization: Bearer ka_your_api_key" \
"https://public-api.kubeadapt.io/v1/clusters/cls-abc123/cost-distribution?timeframe=30d"Example Response
json
{
"cluster_id": "cls-abc123",
"timeframe": "30d",
"data_points": [
{
"timestamp": "2026-03-10T00:00:00Z",
"hourly_cost": 124.8,
"cpu_utilization": 44.2,
"memory_utilization": 61.8,
"efficiency": 0.77
},
{
"timestamp": "2026-03-11T00:00:00Z",
"hourly_cost": 126.1,
"cpu_utilization": 46.5,
"memory_utilization": 63.1,
"efficiency": 0.79
}
]
}Related
- Nodes - Per-node metrics within a cluster
- Namespaces - Namespace-level cost and resource data
- Workloads - Workload metrics and node distribution
- Cost Allocation - Cost breakdown by team and department
- Organization Dashboard - Organization-wide cost trends