usage-budgets

Change the budget on one of the caller's organization's active policies.

Organization admin only. The named policy is retired and a replacement holding the new budget is created, so repeating the call refuses: the policy it addresses is by then out of force, and the replacement has an id of its own.

An increase must leave the organization's active budgets for the resource kind summing under its ceiling. A change that does not raise the budget is accepted whatever that sum is, which is what lets an organization whose ceiling was lowered beneath its allocations reduce its way back under it.

The replacement is charged for the window's history as it is created, which is how consumption already measured survives the change, and the response says what that charge wrote. A charge that cannot be computed refuses the call and leaves the addressed policy in force with the budget it had.

Live workers the policy counts are told their new limits after the response is sent, since the change is already in force whether or not they hear of it.

post/organization/usage-policies/{policy_id}/budget

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/organization/usage-policies/{policy_id}/budget
  • Auth
    none declared

Path parameters

policy_idstring uuid required

Request body

budgetinteger required

Credits the policy's scope may consume per window. 0 forbids all usage. The organization's active budgets for the resource kind must sum under the ceiling Traversal set, unless the change lowers this one.

Response

Successful Response

Changes

    • warning

      added the new worker enum value to the / response property for the response status

    • warning

      added the new worker enum value to the / response property for the response status

    • info

      added the required property to the response with the status