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

agent_name
string

Accepts repeated parameters or comma-separated values.

operation
string

Accepts repeated parameters or comma-separated values.

user_id
string

Accepts repeated parameters or comma-separated values.

virtual_key_id
string

Accepts repeated parameters or comma-separated values.

team_id
string

Accepts repeated parameters or comma-separated values.

customer_id
string

Accepts repeated parameters or comma-separated values.

business_unit_id
string

Accepts repeated parameters or comma-separated values.

project_id
string

Accepts repeated parameters or comma-separated values.

event_type
string

Accepts repeated parameters or comma-separated values.

task_state
string

Accepts repeated parameters or comma-separated values.

status
string

Accepts repeated parameters or comma-separated values.

record_kind
string

Accepts repeated parameters or comma-separated values.

request_id
string
trace_id
string
task_id
string
context_id
string
push_config_id
string
delivery_id
string
attempt_id
string
start_time
string<date-time>

RFC3339 timestamp.

end_time
string<date-time>

RFC3339 timestamp.

group_sessions
boolean

Group sessions unless an explicit request, trace, task, context, push configuration, delivery, or attempt ID is supplied.

limit
integer
default:50
Required range: 1 <= x <= 1000
offset
integer
default:0
Required range: x >= 0
sort_by
enum<string>
default:timestamp
Available options:
timestamp,
latency
order
enum<string>
default:desc
Available options:
asc,
desc
selected_id
string
hydrate
boolean
default:false

Response

Success

logs
object[]
required
pagination
object
required