Kubecost API Directory

Welcome to the Kubecost API library! This directory will show you how Kubecost APIs can assist in monitoring, maintaining, and optimizing your cloud spend. Learn also how Kubecost APIs power different features of the UI below.

Throughout our API documentation, you may see two separate endpoints for the same API, with one labeled 'Aggrgegator-only', or a subsection in an article for Aggregator-only parameters. Those endpoints or parameters are only for users who have configured Kubecost Aggregator. If you do not have Aggregator configured in your environment, do not use those Aggregator endpoints or parameters.

Monitoring APIs

Allocation API

The Allocation API 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.

Allocation Trends API

The Allocation Trends API compares cost usage between two windows of the same duration and presents a percentage value showing the change in cost.

Assets API

The Assets API retrieves the backing cost data broken down by individual Kubernetes assets (e.g. node, disk, etc.), and provides various aggregations of this data. Optionally provides the ability to integrate with external cloud assets.

Asset Diff API

The Asset Diff API compares two asset sets between two windows of the same duration and accumulates the results.

Cloud Costs API

The Cloud Costs API retrieves cloud cost data from cloud providers by reading cost and usage reports.

Cloud Cost Trends API

The Cloud Cost Trends API compares cost usage between two windows of the same duration and presents a percentage value showing the change in cloud costs.

Governance APIs

Budget API

The Budget API allows you to establish spending budget rules for your workload across clusters and namespaces to ensure you don't go over your allotted budget.

Cost Events Audit API

The Cost Events Audit API presents recent changes at the cluster level.

Predict API

The Prediction API takes Kubernetes objects as input and produces an estimation of the cost impact when making changes to your workload.

Diagnostic APIs

Events API

The Events API provides a log of different occurrences in your workload in order to help with troubleshooting. Logs generated with this API are helpful for submitting bug reports.

Optimization APIs

Savings API

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/clusterSizingETL	Provides recommendations for sizing clusters (node types and quantities).
/savings/requestSizingV2	Provides recommendations for setting container resource requests.
/savings/abandonedWorkloads	List abandoned workloads based on network traffic.
/cluster/requestsizer/planV2	Applies Kubecost's container request recommendations to your cluster.
/projectDisks	List orphaned disks.
/projectAddresses	List orphaned IP addresses.

Kubecost UI counterparts

Many, but not all, Kubecost APIs power different features in the Kubecost UI. The UI counterpart may not fully reflect all functionality of the corresponding API. Please consult the original API docs for complete details.

API Name	UI Equivalent
Allocation API	Allocations dashboard
Allocation/Cloud Cost Explorer Trends API	Allocations/Cloud Cost Explorer dashboards, Total cost column percentage
Assets API	Assets dashboard
Cloud Cost API	Cloud Costs Explorer dashboard
Budget API	Budgets dashboard
Cost Events Audit API	Audits dashboard
Predict API	Audits dashboard, Estimated monthly cost impact
Savings API	Savings dashboard
Cluster Right Sizing Recommendation API	Cluster Sizing Recommendations page
Container Request Right Sizing Recommendation API	Request right sizing recommendations page
Abandoned Workloads API	Abandoned Workloads page