v1

latestOpenAPI 3.1.0BSD-32026-07-2471176175.5 KB
budgets

Get a single Budget

get/v2/budgets/{budget_id}

Path parameters

budget_idstring required

Unique budget identifier

Query parameters

expandstring[]

If passed, query will expand the properties specified. This is a multi-value query parameter, pass it more than once to specify multiple values, e.g.

  • &expand=current&expand=history

Headers

cloudzero-idempotency-keystring

If passed, any subsequent operation with the same value for this header will return the exact same result. This is true for all responses, i.e. successes and errors.

cloudzero-test-keystring

If passed, the operation executes in the namespace specified by this key. Resource mutations in the namespace last for 1 hour.

Response

Successful Operation

Example response

{
  "budget": {
    "planned_limits": {
      "monthly": {
        "2022-02-01T00:00:00+00:00": {
          "amount": "1000.00"
        }
      }
    },
    "alerts": {
      "80": "N",
      "100": "Y"
    }
  }
}