This resource covers the primary APIs across open-source and commercial Kubecost products, and includes a directory to up-to-date API documentation articles.
The Allocation API is used by the Kubecost Allocation frontend and retrieves cost allocation information for any Kubernetes concept, e.g. cost by namespace, label, deployment, service, and more. This API is directly integrated with the Kubecost ETL caching layer and CSV pipeline so it can scale for large clusters.
The Assets API retrieves the backing cost data broken down by individual assets, e.g. node, disk, etc, and provides various aggregations of this data. Optionally provides the ability to integrate with external cloud assets.
The Cloud Costs API retrieves cloud cost data from cost and usage reports.
The Audit API verifies cached data sources of Kubecost for validity of the data sources and processes through a series of tests.
The Events API provides a log of different occurences in your workload in order to help with troubleshooting. Logs generated with this API are helpful for submitting bug reports.
The Prediction API takes Kubernetes objects as input and produces an estimation of the cost impact when making changes to your workload.
Savings endpoints provide cost optimization insights. The following savings endpoints are available at http://<kubecost-address>/model/ENDPOINT:
| Endpoint | Brief description |
|---|---|
/savings |
Provides cluster-level potential savings estimates based on specific savings opportunities available in other endpoints. |
/savings/requestSizing |
Provides recommendations for setting container resource requests. |
/projectDisks |
List orphaned disks. |
/projectAddresses |
List orphaned IP addresses. |
/savings/abandonedWorkloads |
List abandoned workloads based on network traffic. |
/savings/clusterSizing |
Provides recommendations for sizing clusters (node types and quantities). |