Skip to main content
POST
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

id
string

Optional recalculation job ID. Omit to cancel the current in-flight recalculation.

Response

Recalculation cancellation accepted, or the selected job was already terminal

Recalculate cost job status

id
string

Background job ID

status
enum<string>

Current job status

Available options:
pending,
running,
completed,
failed,
cancelled,
idle
total
integer<int64>

Total matching logs queued for recalculation

processed
integer<int64>

Logs processed so far

updated
integer<int64>

Logs updated with new costs

skipped
integer<int64>

Logs skipped during processing

unpriceable
integer<int64>

Subset of skipped logs whose pricing inputs could not be recovered, so their existing cost was left unchanged.

message
string

Optional progress message

last_error
string

Last error encountered by the job

started_at
string<date-time>

Job start time

updated_at
string<date-time>

Last status update time