Skip to main content
POST
Create a cost budget (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.

Body

application/json

Body of POST /api/v1/org/cloud-cost/budgets.

scope_kind
enum<string>
required
Available options:
organisation,
cluster,
environment,
application
name
string
required

1 to 120 characters.

monthly_cents
integer
required

The budget in the currency's minor unit; positive.

currency
string
required

One of the platform's convertible currencies.

scope_id
string | null

A cluster or application id of the organisation, or an environment label; omitted or null for the organisation.

owner_user_id
string<uuid> | null

An active member of the organisation the budget is for.

notify_at_pct
integer
default:80

1 to 100.

Response

Created

A monthly cost budget for one scope with its month as of the read.

id
string<uuid>
required
name
string
required
scope_kind
enum<string>
required
Available options:
organisation,
cluster,
environment,
application
scope_id
string | null
required

The cluster or application id, or the environment label; null for the organisation.

scope_name
string
required

What the scope is called now; empty for a cluster or application the organisation no longer has.

monthly_cents
integer
required

The budget, in currency.

currency
string
required
owner_user_id
string<uuid> | null
required

Who the budget is for.

notify_at_pct
integer
required

The share of the budget the projection must reach for the budget's card (cost_budget_crossing) to be raised.

created_by
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
month
string
required

The UTC month the projection is for, YYYY-MM.

projection
BudgetProjection · object
required

A budget's month as of the read, in the budget's currency. Every figure is null while the scope has no priced cluster (status unknown): an unread month is not a month with no spend.