Sign in
scoped-budgets

Update Scoped Budget

Changed on

Relabel a ceiling, or point it at a different budget.

The scope and the provider narrowing are not editable: changing either would move the ceiling to a different identity while carrying its spend, which is a delete and a create, not an update.

There is no limit or period to set here any more. Both are properties of the budget, so changing what a ceiling allows is either editing that budget, which moves every ceiling naming it, or naming a different one.

patch/api/v1/scoped-budgets/{budget_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

budget_idstring required

Request body

budget_idstring nullable
namestring nullable

Response

Successful Response

budget_duration_secinteger nullable required
budget_idstring required
created_atstring required
current_requestsinteger required
current_spendnumber required
current_tokensinteger required
idstring required
max_budgetnumber nullable required
namestring nullable required
period_endstring nullable required
period_startstring nullable required
provider_key_idstring nullable required
request_limitinteger nullable required
reserved_requestsinteger required
reserved_spendnumber required
reserved_tokensinteger required
reset_alignmentstring nullable required
scope_idstring required
scope_typestring required
token_limitinteger nullable required
updated_atstring required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id update_scoped_budget_api_v1_scoped_budgets__budget_id__patch removed and replaced with scoped-budgets-update_scoped_budget