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.

Query Parameters

limit
integer
default:25

Page size, 0 to 100 (default 25). Values above 100 are clamped to 100 without an error, and 0 uses the default, so read limit back from the response. Page with offset until offset >= total_count. Without limit, offset, search, scope, scope_id or provider, every model limit is returned. With from_memory=true the 100 cap does not apply and an omitted limit returns every match.

Required range: 0 <= x <= 100
offset
integer
default:0

Number of results to skip (for pagination)

Required range: x >= 0

Case-insensitive filter by model name

scope
string

Comma-separated scopes to filter by. project, access_profile and the legacy user are Enterprise only.

scope_id
string

Filter to one scope target, for example a project id. Pair it with scope.

provider
string

Filter by provider name

from_memory
boolean
default:false

If true, returns data from in-memory cache (faster, may lag DB by one poll cycle)

Response

Successful response

Response containing list of model configs

model_configs
object[]
count
integer

Number of model configs in this response

total_count
integer

Number of model configs matching the query before limit and offset. Equals count on the unpaged path.

limit
integer

Page size applied after clamping (default 25, maximum 100). On the unpaged path, the number of model configs returned.

offset
integer

Offset applied; 0 on the unpaged path.