v1

latestOpenAPI 3.0.02026-07-241310301.1 KB

Budgets

Create Budget

The call is used to create budgets

post/api/v2/budgets

Authorizationstring required

apikeystring required

budgetNamestring required

The name in the Umbrella Cost UI

costTypestring required

Valid values: “amortized”,”net_amortized”,”unblended”

budgetTypestring required

Valid values: “recurring”, “expiring”

budgetAmountTypestring required

Valid values: “fixed”,”planned”

budgetAmountinteger required

The total budget

budgetAmountsstring[] required

An array of amount and month pairs. Example: {"amount": 1234 ,"date": "2024-2"},{"amount": 5000 ,"date": "2024-3"}

isFlexiblestring required

Valid Values: "true", "false"

isRelativeAlertsstring

Do not use this parameter

periodinteger required

Valid values: 0-"Monthly", 1-"Quarterly", 2-"Yearly"

startDatestring date-time required

Example: “2024-02-11T09:25:29.800Z”

endDatestring date-time required

Example: "2025-02-11T09:25:29.809Z"

includeFiltersstring

object of filter keys - Example: {"region": ["af-south-1"]}

excludeFiltersstring

object of filter keys - Example: {"chargetype": ["Tax"]}

budgetAlertsstring[]

An array of alerts defined over the budget

whenToAlertstring[] required

Valid values: “forecasted", ”actualUsage” of both

alertGranularitystring[] required

Valid values: ”monthly”, “daily”, “total” or combinations of them

alertPercent string required

Budget percent utilization thereshold

alertEmailstring required

valid email addresses, separated by commas