Get a budget for the organization.

Base URL
https://cloud.elastic.co Public

Retrieves a budget for the specified organization. Callers with org-wide budget access receive any budget in the organization. Others receive cloud-resource-scoped budgets only when all scope values are resources they can access; otherwise 403 Forbidden. Scope values referring to deleted instances are ignored.

Path parameters

organization_id string required

The organization ID

budget_id integer required

The budget ID

Responses

Budget successfully retrieved

application/json
active boolean required
alerts object[] required
created_at string
id integer required
last_exceeded_at string
operator enum required
Values: gte
threshold integer required
threshold_type enum required
Values: percentage
amount integer required
created_at string
id integer required
name string
period enum required
Values: monthly
recipient_group enum[] required
Values: organization-admins billing-admins resource-viewers resource-editors resource-admins
scope_type enum required
Values: organization cloud_resource
scope_values string[] required
window object

Recurring budget window. Allowed (repeat_unit, repeat_every) pairs: daily (day, 1), weekly (week, 1), monthly (month, 1), quarterly (month, 3), yearly (year, 1). Windows reset at 00:00 UTC; spend is counted from the later of the window start and the budget creation time. reset_on is omitted for daily windows.

repeat_every integer required
repeat_unit enum required
Values: day week month year
reset_on object

The user's reset selection. Only the fields required by the window frequency are set: weekly uses weekday, monthly uses day, quarterly uses month, yearly uses month and day. Days 29-31 clamp to the last day of shorter months, recomputed every period from this selection (day 31 resets on Jan 31, Feb 28, Mar 31, Apr 30; Feb 29 resets on Feb 28 in non-leap years).

day integer

Day of the month, 1 to 31.

month enum
Values: jan feb mar apr may jun jul aug sep oct nov dec
weekday enum
Values: mon tue wed thu fri sat sun
403

Not allowed to read this budget

404

Budget not found

500

Internal server error

Base URL
https://cloud.elastic.co Public