Skip to main content
GET
Get a stack's cost projection (bearer twin)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required
stack_name
string
required

The stack's name on the cluster.

Response

Successful response

What one object of the organisation costs now and over the last 30 days, read from the same snapshots and staleness window as the fleet summary. A cluster-based object (a cluster, a credential) costs its clusters' run rate, idle capacity included; a namespace-based object (a namespace, a stack, an application) costs its namespaces' allocations and has no idle share. Nothing unknown reads as zero.

kind
enum<string>
required
Available options:
cluster,
namespace,
stack,
application,
credential
object
ObjectCostSubject · object
required
currency
string
required

The caller's display currency; every *_cents figure is in its minor units.

priced
boolean
required

At least one cluster behind the object contributed a figure. False leaves every figure null and names why in unpriced_reason.

unpriced_reason
string | null
required
monthly_cents
integer | null
required

The run rate at the latest snapshot inside the window, times 730 hours.

idle_pct
number | null
required

The share of the run rate idle capacity accounts for; cluster-based objects only.

share_of_fleet_pct
number | null
required

monthly_cents over the fleet's run rate in the same window; null when either is unknown or the fleet is zero.

confidence
string | null
required

The lowest confidence among the snapshots the figure is read from: high, medium or low.

coverage_incomplete
boolean | null
required

The figure is a floor: a node or billed resource of a contributing cluster could not be priced, or a cluster behind the object contributed no figure (clusters names which).

open_waste
ObjectCostWaste · object
required

The open cloud waste attributed to the object. Waste is found per cloud resource, so only a cluster or a credential carries it; available false names why it is not read, which is unknown, not none.

trend_30d
ObjectCostDay · object[]
required

The object's cost per UTC day over the last 30 days, oldest first.

clusters
ObjectCostCluster · object[]
required
namespaces
ObjectCostNamespace · object[]
required

The namespaces behind a namespace-based object; empty for a cluster-based one.

snapshot_stale_after_hours
integer
required

The window a snapshot counts in.