Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Audit Logs in Bifrost Enterprise record administrative activity so operators can review who changed what, when it happened, and which resource was affected. Audit log entries can be signed with an HMAC key, retained for a configurable number of days, viewed in the dashboard, and exported for downstream review.
Audit logs screen

Key Features

FeatureDescription
Signed eventsConfigure an HMAC key so audit entries can be verified.
Dashboard reviewView audit entries from the Audit Logs workspace page.
FilteringFilter by search text, action, outcome, and date range.
ExportExport matching entries as JSON, JSON Lines, or Syslog when the user has download permission.
RetentionConfigure how long audit log entries are kept.

Configuration

{
  "audit_logs": {
    "disabled": false,
    "hmac_key": "env.AUDIT_HMAC_KEY",
    "retention_days": 365
  }
}

Configuration Fields

FieldTypeDescription
disabledbooleanWhen true, audit logging is turned off. Default: false.
hmac_keystringHMAC secret key used to sign audit events. Minimum 32 bytes. Supports env. prefix for environment variables (e.g. env.AUDIT_HMAC_KEY).
retention_daysintegerDays to retain audit log entries. 0 disables retention-based cleanup.

Viewing Audit Logs

Open Governance > Audit Logs in the Bifrost dashboard. The table shows:
ColumnDescription
TimeWhen the event occurred.
ActionThe operation performed, such as create, update, delete, authenticate, authorize, export, or import.
OutcomeThe result of the operation: success, failure, or pending.
InitiatorThe user, API key, or system actor that initiated the action.
TargetThe resource affected by the action.
PathThe request method and path, when available.
IPThe request IP address, when available.
DurationRequest duration in milliseconds, when available.
You can search by initiator, target, IP, or path, and filter by action, outcome, start date, and end date.

Exporting Audit Logs

Users with AuditLogs:Download permission can export the currently filtered audit log results from the dashboard. Supported export formats:
FormatUse Case
JSONStructured review or ad hoc processing.
JSON LinesLine-delimited ingestion pipelines.
Syslog (RFC 5424)SIEM or log-forwarding pipelines that accept syslog records.

API Reference

For the exact request and response contract, see the API Reference.