v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB

Budget V2 Management

View Budget Dashboard

List Budget Management

post/budget/dashboard/list_budgets

Request body

statusstring[]

Budget status. Allowed values are pending/in_progress/completed/expired

billing_sourcestring

Cost metric used to calculate the budget amount

budget_engine'Cloud_Native' | 'System'

budget engine can be Cloud_Native or System

service_namestring[]

The name of the cloud service. For example, AWS.

cloud_account_idstring[]

Specify the cloud account id to view, cloud account id is unique and can be obtained from the list cloud account api.

project_idstring[]

Tenant ids

dimension_idstring[]

Dimension IDs for the budget. This is a unique ID and can be retrieved using

grouping_rule_idsstring[]

List of grouping rule IDs to be associated with the budget. This is a unique.

currency'AED' | 'ALL' | 'ARS' | 'AUD' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BRL' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MOP' | 'MVR' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'USD' | 'VND' | 'ZAR' required

currency of the cost. Example 'currency':'USD'

active_onlyboolean

When true, returns only active budgets.

start_datestring date-time

ISO 8601 UTC datetime. When provided with end_date, filters to budgets whose period overlaps the given range.

end_datestring date-time

ISO 8601 UTC datetime. When provided with start_date, filters to budgets whose period overlaps the given range.

Example request

{
  "status": [
    "pending"
  ],
  "budget_engine": "Cloud_Native",
  "service_name": [
    "AWS"
  ],
  "currency": "AED"
}

Response

Success

total_budgets_countinteger required

Total Budgets count

Example response

{
  "budgets_list": [
    {
      "budget_engine": "Cloud_Native",
      "budget_scope": "cloud",
      "scope": {
        "cloud": [
          "AWS"
        ]
      }
    }
  ]
}