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

relay_names
string

Relay names to filter by. Accepts repeated parameters or comma-separated values.

methods
string

HTTP methods to filter by. Accepts repeated parameters or comma-separated values.

statuses
string

Statuses to filter by (success, error, cancelled). Accepts repeated parameters or comma-separated values.

kinds
string

Row kinds to filter by (call, job). Accepts repeated parameters or comma-separated values.

virtual_key_ids
string

Virtual key IDs to filter by. Accepts repeated parameters or comma-separated values.

user_ids
string

User IDs to filter by. Accepts repeated parameters or comma-separated values.

team_ids
string

Team IDs to filter by. Accepts repeated parameters or comma-separated values.

customer_ids
string

Customer IDs to filter by. Accepts repeated parameters or comma-separated values.

business_unit_ids
string

Business unit IDs to filter by. Accepts repeated parameters or comma-separated values.

project_ids
string

Project IDs to filter by. Accepts repeated parameters or comma-separated values.

apps
string

Client applications (as detected from the User-Agent) to filter by. Accepts repeated parameters or comma-separated values.

billable
boolean

Keep only billable (true) or non-billable (false) calls.

start_time
string<date-time>

Start of the time range (RFC3339).

end_time
string<date-time>

End of the time range (RFC3339).

min_cost
number

Minimum cost in USD.

max_cost
number

Maximum cost in USD.

request_id
string

Exact request ID.

job_id
string

Exact upstream job ID.

Free-text match on the path, matched route, model and request ID. Metadata columns only, never bodies.

limit
integer
default:50

Number of rows to return (default 50, max 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of rows to skip

Required range: x >= 0
sort_by
enum<string>
default:timestamp

Field to sort by. Unknown values fall back to timestamp.

Available options:
timestamp,
latency,
cost
order
enum<string>
default:desc

Sort order. Anything other than asc sorts descending.

Available options:
asc,
desc

Response

One page of relay logs

logs
object[]
required
pagination
object
required

Pagination metadata of a Relay Logs page. Relay logs sort by timestamp, latency or cost only.

has_logs
boolean
required

Whether any relay log exists at all, so an empty page can be told from an empty store.