List Alive Clusters with Savings and Realizations
GET/clusters/
Retrieve a list of clusters that are considered alive (updated within the last 4 days) along with savings and realizations filtered by the days
parameter. Clusters are updated every 2 hours by a metadata ingest job, which fetches cluster metadata from AWS using boto3
calls. The days
parameter filters savings and realizations for the specified time period but does not affect which clusters are returned.
Request
Query Parameters
Number of days to filter savings and realizations. For example, if days=30
, the savings and realizations for the past 30 days will be returned. This does not affect which clusters are returned.
Header Parameters
API key for authentication
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
configuration_statuses
object
required
[
{
"id": 0,
"external_id": "string",
"name": "string",
"arn": "string",
"region": "string",
"vpc": "string",
"status": "string",
"client_id": "string",
"account_id": "string",
"last_agent_status": "2024-07-29T15:51:28.071Z",
"onboarded": true,
"onboarded_at": "2024-07-29T15:51:28.071Z",
"configured": true,
"configuration_statuses": {
"karpenter": false,
"cluster_autoscaler": false,
"bc_plus": false,
"k8s_data_fetcher": false
},
"installed_agent_version": "string",
"is_ga_karpenter": false,
"eks_version": "string",
"savings_daily": 0,
"savings_for_period": 0,
"realized_daily": 0,
"realized_for_period": 0,
"cost_daily": 0,
"cost_for_period": 0,
"autoscaler_type": "string",
"api_key_id": 0
}
]
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}