WebSocket connection

Upgrades to a WebSocket connection for real-time updates. Server pushes log events, MCP log events, and store update notifications. Heartbeat pings are sent every 30 seconds.

Every message is an envelope with a type discriminator. Two carry governance-project state:

• store_update names the resources that changed, so a client holding a cached list can refetch it. A project create, edit, delete or member change sends {"type": "store_update", "tags": ["Projects"]}.
• redivision_progress reports an equal-split project recalculating every member’s share of every cap. Its operation_id matches the redivision_job_id returned by the project and member routes, and by a user deletion, so a client can follow the job it started.

The message shapes are documented as StoreUpdateMessage and RedivisionProgressMessage; they arrive over the socket rather than as an HTTP response body.

GET /ws

Error

A valid request URL is required to generate request examples

101

{
  "type": "store_update",
  "tags": [
    "Projects"
  ]
}

Required Permissions

Permission	Granted via
None	Any authenticated caller - exempt from RBAC

How permissions work

Authorizations

ManagementBearerAuthBasicAuthSessionCookieAuth

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

ticket · string

Single-use WebSocket ticket from POST /api/session/ws-ticket. Use this when an Authorization header cannot be set (browser WebSocket clients).

Response

101 - application/json

WebSocket upgrade successful

Option 1

Option 2

One of the server-pushed message envelopes. Listed here because the spec has nowhere else to describe a socket payload.

type · string

Allowed value: "store_update"

tags · string[]

Resource names, matching the dashboard's cache tags, for example Projects, VirtualKeys, Providers, MCPClients.

Example:

["Projects"]