Skip to content
Version: Current

DELETE and PUT /v1/admin/budgets/{scope}/{scope_id}/{period}

Part of the API reference; this page is generated from the OpenAPI document that the gateway builds from its own route tables.

  • Contract version: 1.10.0
  • Contract title: acumen gateway API
  • Source: acumen:docs/openapi/acumen-v1.openapi.json

DELETE /v1/admin/budgets/{scope}/{scope_id}/{period}

Section titled “DELETE /v1/admin/budgets/{scope}/{scope_id}/{period}”

Delete a hard-cap budget policy

Removes the policy, which lifts the cap. Operator (admin) scope.

  • Operation id: deleteV1AdminBudgetsScopeScopeIdPeriod
  • Scope: admin
  • Exposure: operator
  • Mutating: yes
  • Auth: bearerAuth, operatorSession

Responses

  • 204: deleted
  • 400: schema_invalid — the request body or parameter failed validation
    • application/problem+json: Problem: Problem (object)
  • 401: auth_missing — no virtual key or operator session
    • application/problem+json: Problem: Problem (object)
  • 403: auth_scope — the credential lacks the route’s scope
    • application/problem+json: Problem: Problem (object)
  • 404: resource_not_found — the addressed object does not exist
    • application/problem+json: Problem: Problem (object)
  • 405: method_not_allowed — the path exists for another verb
    • application/problem+json: Problem: Problem (object)
  • 429: rate_limited — the per-key or per-IP bucket is exhausted
    • application/problem+json: Problem: Problem (object)
  • 500: internal — the store or process failed
    • application/problem+json: Problem: Problem (object)
  • 501: not_implemented — the route is declared but not wired in this build
    • application/problem+json: Problem: Problem (object)
  • 503: store_unavailable — the dependency is down; retryable
    • application/problem+json: Problem: Problem (object)

PUT /v1/admin/budgets/{scope}/{scope_id}/{period}

Section titled “PUT /v1/admin/budgets/{scope}/{scope_id}/{period}”

Create or replace a hard-cap budget policy

Upserts the policy for (scope, scope_id, period). limit_usd must be positive; enabled:false keeps the row but lifts the cap; alert_pcts (default 80, 100) are the threshold alerts written to the notification feed. Hot-reloaded. Tenant-bound keys are refused 403. Operator (admin) scope.

  • Operation id: putV1AdminBudgetsScopeScopeIdPeriod
  • Scope: admin
  • Exposure: operator
  • Mutating: yes
  • Auth: bearerAuth, operatorSession

Request

  • Request body (application/json, required): BudgetPolicyPut: BudgetPolicyPut (object)
Field Type Required Notes
alert_pcts array of integer no
enabled boolean no
limit_usd number yes
tenant_id string no

Responses

  • 200: OK
    • application/json: BudgetPolicy: BudgetPolicy (object)
  • 400: schema_invalid — the request body or parameter failed validation
    • application/problem+json: Problem: Problem (object)
  • 401: auth_missing — no virtual key or operator session
    • application/problem+json: Problem: Problem (object)
  • 403: auth_scope — the credential lacks the route’s scope
    • application/problem+json: Problem: Problem (object)
  • 404: resource_not_found — the addressed object does not exist
    • application/problem+json: Problem: Problem (object)
  • 405: method_not_allowed — the path exists for another verb
    • application/problem+json: Problem: Problem (object)
  • 429: rate_limited — the per-key or per-IP bucket is exhausted
    • application/problem+json: Problem: Problem (object)
  • 500: internal — the store or process failed
    • application/problem+json: Problem: Problem (object)
  • 501: not_implemented — the route is declared but not wired in this build
    • application/problem+json: Problem: Problem (object)
  • 503: store_unavailable — the dependency is down; retryable
    • application/problem+json: Problem: Problem (object)