Update provider governance

Updates governance settings (budget and rate limits) for a specific provider.

PUT /api/governance/providers/{provider_name}

Error

A valid request URL is required to generate request examples

200

{
  "provider": "<string>",
  "budgets": [
    {
      "id": "<string>",
      "max_limit": 123,
      "reset_duration": "<string>",
      "last_reset": "2023-11-07T05:31:56Z",
      "current_usage": 123,
      "config_hash": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "reset_config": {
        "quarter_start_month": 6
      },
      "override_amount": 123,
      "override_mode": "cycles",
      "override_cycles_remaining": 123,
      "override_cycles_total": 123,
      "override_anchor_reset": "2023-11-07T05:31:56Z",
      "team_id": "<string>",
      "virtual_key_id": "<string>",
      "provider_config_id": 123
    }
  ],
  "budget": {
    "id": "<string>",
    "max_limit": 123,
    "reset_duration": "<string>",
    "last_reset": "2023-11-07T05:31:56Z",
    "current_usage": 123,
    "config_hash": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "reset_config": {
      "quarter_start_month": 6
    },
    "override_amount": 123,
    "override_mode": "cycles",
    "override_cycles_remaining": 123,
    "override_cycles_total": 123,
    "override_anchor_reset": "2023-11-07T05:31:56Z",
    "team_id": "<string>",
    "virtual_key_id": "<string>",
    "provider_config_id": 123
  },
  "rate_limit": {
    "id": "<string>",
    "token_current_usage": 123,
    "token_last_reset": "2023-11-07T05:31:56Z",
    "request_current_usage": 123,
    "request_last_reset": "2023-11-07T05:31:56Z",
    "config_hash": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "token_max_limit": 123,
    "token_reset_duration": "<string>",
    "request_max_limit": 123,
    "request_reset_duration": "<string>"
  },
  "calendar_aligned": false
}

Authorizations

ManagementBearerAuthBasicAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Path Parameters

provider_name · string · required

Provider name

Body

application/json

Request to update provider governance settings

budgets · object[] | null

Full desired set of budgets. Pointer-to-slice semantics apply: omitting the field leaves budgets unchanged; sending an empty array [] removes all budgets; sending a non-empty array replaces all existing budgets with the provided set.

Show child attributes

budget · object

Deprecated: use budgets.

Show child attributes

rate_limit · object

Rate limit configuration

Show child attributes

calendar_aligned · boolean | null

When true, all budgets reset at clean calendar boundaries. Omit to leave unchanged.

reset_budget_usage · boolean

When true, zeroes current usage on the budgets reconciled by this update. The reset window is left alone: last_reset only ever advances, and never as a side effect of a configuration write, so the current window keeps its existing start and end.

Response

200

application/json

Provider governance updated successfully

Response containing provider governance settings

provider · string

Provider name

budgets · object[]

Budget configurations for this provider. Each entry has a unique reset_duration.

Show child attributes

budget · object

Deprecated: use budgets. Returns the first budget for backward compatibility.

Show child attributes

rate_limit · object

Rate limit configuration

Show child attributes

calendar_aligned · boolean · default: false

When true, all budgets reset at clean calendar boundaries (midnight UTC for day, Monday for week, 1st for month, Jan 1 for year).