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

id
string
required

Query Parameters

hydrate
boolean
default:false

Response

Success

id
string
required
timestamp
string<date-time>
required
record_kind
string
required
operation
string
required
status
string
required
agent_name
string
required
request_id
string
required
raw_request
string

Base64-encoded upstream body bytes, when raw capture is available.

raw_response
string

Base64-encoded upstream body bytes, when raw capture is available.

session_child_count
integer
user_id
string
user_name
string
virtual_key_id
string
virtual_key_name
string
team_id
string
team_name
string
team_ids
string[]
team_names
string[]
customer_id
string
customer_name
string
customer_ids
string[]
customer_names
string[]
business_unit_id
string
business_unit_name
string
business_unit_ids
string[]
business_unit_names
string[]
project_id
string
project_name
string
budget_ids
string[]
rate_limit_ids
string[]
trace_id
string
task_id
string
context_id
string
message_id
string
request_message_id
string
response_message_id
string
artifact_id
string
push_config_id
string
delivery_id
string
attempt_id
string
event_sequence
integer
event_type
string
task_state
string
downstream_transport
string
upstream_transport
string
latency
number
upstream_latency
number
overhead_latency
number
overhead_breakdown
object[]
content_type
string
input
string
request_body
string
response_body
string
event_body
string
plugin_logs
string
error_details
object

Error response from Bifrost