Skip to main content
GET
Error
Required Permissions How permissions work

Authorizations

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.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.

OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account, or auth disabled), every management endpoint except the public ones (/health, /api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization. The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN environment variable. A missing header returns 401, a wrong token 403. The header stops working once dashboard auth is enabled. The dashboard instead trades the token once for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup. See Required permissions for how permissions are derived and which endpoints are exempt.

Path Parameters

router_id
string
required

The model router; an unknown router is 404.

Query Parameters

window
string

Hours or days (24h, 7d); omitted is the whole lookback. Shorter than one second or longer than the lookback is 400.

Example:

"7d"

Response

Run estimated

requests
integer

Requests in the window, captured and to be backfilled.

clustered
integer

Size of the sample of the window the run would cluster, up to its clustering budget.

assigned
integer

Requests outside the sample the run would try to assign to the clusters it finds. A request joins a cluster only if it is close enough to one, so fewer may end up counted.

skipped
integer

Requests past the run's assignment bound, not counted.

max_model_calls
integer

The most suggestion-model calls the run could make.

backfill
integer

Requests in the window from before the router captured them, which the run embeds from their logs first (up to the run's clustering budget); counted in requests. Omitted when none.

backfill_unknown
boolean

True when what a run would embed from logs could not be planned; requests then counts only what is captured. Omitted when false.