Skip to main content
GET
Error
This path is deprecated and will be removed in the following major release. Use /api/governance/audit-logs/export instead.
This endpoint is available in Bifrost Enterprise only.
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

format
enum<string>
default:json

Export format. Defaults to json when omitted or unrecognized.

  • json: a JSON array of events
  • jsonl: JSON Lines, one event per line
  • syslog: RFC 5424 syslog format
Available options:
json,
jsonl,
syslog

Free-text search across audit event fields.

actions
string

JSON array of CADF actions to filter by (OR match).

outcomes
string

JSON array of outcomes to filter by (OR match).

event_types
string

JSON array of event types to filter by (OR match).

start_date
string

Filter events at or after this time (RFC3339 or YYYY-MM-DD).

end_date
string

Filter events at or before this time (RFC3339 or YYYY-MM-DD).

period
string

Relative time window that overrides start_date/end_date when set (e.g. 24h, 7d).

Response

A streamed export of the matching audit logs.

The response is of type string.