Skip to content
tcpsystems
Version: Current

GET /v1/admin/budgets

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

Provenance

Section titled “Provenance”
  • Contract version: 1.10.0
  • Contract title: acumen gateway API
  • Source: acumen:docs/openapi/acumen-v1.openapi.json

Operations

Section titled “Operations”

GET /v1/admin/budgets

Section titled “GET /v1/admin/budgets”

List hard-cap budget policies with live reconciliation state

Every opt-in budget policy (account, project or key scope; day, week or month period). Caps are OFF by default: with no enabled policy nothing is capped (default: "off"). Each enabled policy carries state: effective spend (max(local, ledger)), the request-ledger floor, this process’s own counter, outstanding holds and the drift between them. An enabled policy fails closed — a breached cap is 402 budget_tenant/budget_project/budget_key_*, an unreadable ledger is 503 budget_unavailable. BYOK spend is charged at priced cost. A tenant-bound admin key sees only its tenant’s rows. Operator (ops:read) scope.

  • Operation id: getV1AdminBudgets
  • Scope: ops:read
  • Exposure: operator
  • Mutating: no
  • Auth: bearerAuth, operatorSession

Responses

  • 200: OK
    • application/json: BudgetPolicyList: BudgetPolicyList (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)