Skip to main content
DELETE
Error

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

provider
string
required

Provider name

Response

Provider deleted successfully

Provider configuration response

name
enum<string>

AI model provider identifier

Available options:
anthropic,
azure,
bedrock,
bedrock_mantle,
cerebras,
cohere,
deepseek,
gemini,
groq,
mistral,
ollama,
opencode-go,
opencode-zen,
openai,
parasail,
perplexity,
sgl,
vertex,
openrouter,
elevenlabs,
huggingface,
nebius,
xai,
replicate,
vllm,
runway,
runware,
fireworks,
sarvam,
wafer,
databricks
network_config
object

Network configuration for provider connections

concurrency_and_buffer_size
object

Concurrency settings

proxy_config
object

Proxy configuration

send_back_raw_request
boolean
send_back_raw_response
boolean
store_raw_request_response
boolean
custom_provider_config
object

Custom provider configuration

prompt_cache
object

Synthesize prompt-cache breakpoints for requests that carry none. Off by default. Requests that already carry their own cache markers are never modified.

provider_status
enum<string>

Status of the provider

Available options:
active,
error,
deleted
status
string

Operational status (e.g., list_models_failed)

description
string

Error/status description

config_hash
string

Hash of config.json version, used for change detection