kubecost

Product and technical docs

View project on GitHub

This resource covers primary APIs across open source and commercial Kubecost products.

Open source APIs

/costDataModel

Returns unaggregated cost model rate data at the individual container/workload level. Does not include ETL caching layer and therefore optimal for small to medium-sized clusters.

/costDataModelRange

Time-series version of /costDataModel API. Does not include ETL caching layer and therefore optimal for small to medium-sized clusters.

Other APIs (available in Free tier)

/allocation

The Kubecost 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 is able to scale to large clusters.

/aggregatedCostModel

The aggregated cost model API is actively being replaced by the Kubecost Allocation API.

/assets

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.

Savings

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). /savings/diagnostics Reports cached keys in the savings handlers and recent errors.