Sign in

v1

latestOpenAPI 3.1.0BSD-32026-07-2471176175.5 KB
budgets

Create a new Budget

post/v2/budgets

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.

Request body

namestring required

Budget name, must be unique within a View

alertsBudgetAlerts

Mapping of 1-100 to Y/N, where

  • 1-100 is the percentage of the budget at which to send an alert
  • Y/N is whether or not to send the alert

Example request

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

Response

Successful Operation

Example response

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