Cloud Cost API

Cloud Cost API (Querying)

GET http://app.kubecost.com/query/cloudcost/query

The Cloud Cost API is the preferred way to query for costs and resources related to cloud provider services.

Path Parameters

Name
Type
Description

window*

string

Duration of time over which to query. Accepts multiple formats including units of time, relative time units, and unix timestamps. See this section on using the window parameter for more information.

format

string

File type when exporting query. Currently only supports json.

aggregate

string

Used to consolidate cost model data. Supported values are invoiceEntityID, accountID, provider, providerID, category, and service, as well as label:<name>. Passing an empty value for this parameter or none at all returns data by an individual cloud cost. Supports multi-aggregation (aggregation of multiple categories) in a comma separated list, such as aggregate=provider,service.

accumulate

boolean

If true, sum the entire range of time intervals into a single set. Default value is false.

costMetric

String

Determines which cloud cost metric type will be returned. Acceptable values are amortizedNetCost, amortizedCost, invoicedCost, listCost, and netCost. Default is amortizedNetCost.

limit

int

Refers to the number of line items per page. Currently, only supported together with accumulate=true to obtain a single list of line items.

filter

string

Filter your results by any category which you can aggregate by, can support multiple filterable items in the same category in a comma-separated list. For example, to filter results by categories A and B, use filter=category:categoryA,categoryB See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.

Cloud Costs API (Total)

GET http://app.kubecost.com/query/cloudcost/totals

The /totals endpoint does not aggregate, and accepts only a window and an optional filter, returning a single total cost.

Path Parameters

Name
Type
Description

window*

string

Duration of time over which to query. Accepts multiple formats including units of time, relative time units, and unix timestamps. See this section on using the window parameter for more information.

format

string

File type when exporting query. Currently only supports json.

filter

string

Filter your results by any category which you can aggregate by, can support multiple filterable items in the same category in a comma-separated list. For example, to filter results by categories A and B, use filter=category:categoryA,categoryB See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.

Last updated