A valid request URL is required to generate request examples{
"client_config": {
"drop_excess_requests": true,
"prometheus_labels": [
"<string>"
],
"allowed_origins": [
"<string>"
],
"initial_pool_size": 123,
"enable_logging": true,
"disable_content_logging": true,
"allow_per_request_content_storage_override": false,
"allow_per_request_raw_override": false,
"enforce_auth_on_inference": true,
"vk_rotation_cooldown": 0,
"enforce_governance_header": true,
"max_request_body_size_mb": 123,
"compat": {
"convert_text_to_chat": true,
"convert_chat_to_responses": true,
"should_drop_params": true,
"should_convert_params": false,
"azure_deepseek": false
},
"log_retention_days": 123,
"header_filter_config": {
"allowlist": [
"<string>"
],
"denylist": [
"<string>"
]
},
"mcp_agent_depth": 123,
"mcp_tool_execution_timeout": 123,
"mcp_tool_sync_interval": 1,
"mcp_code_mode_binding_level": "<string>",
"required_headers": [
"<string>"
],
"logging_headers": [
"<string>"
],
"mcp_external_client_url": "<string>",
"mcp_server_auth_mode": "headers",
"oauth2_server_config": {
"issuer_url": "<string>",
"auth_code_ttl": 300,
"access_token_ttl": 600,
"disable_vk_identity": false
}
},
"framework_config": {
"id": 123,
"pricing_url": "<string>",
"pricing_sync_interval": 123
},
"auth_config": {
"admin_username": "<string>",
"admin_password": "<string>",
"is_enabled": true,
"disable_auth_on_inference": true
},
"is_db_connected": true,
"is_cache_connected": true,
"is_logs_connected": true,
"proxy_config": {
"enabled": true,
"type": "http",
"url": "<string>",
"username": "<string>",
"password": "<string>",
"no_proxy": "<string>",
"timeout": 123,
"skip_tls_verify": true,
"enable_for_scim": true,
"enable_for_inference": true,
"enable_for_api": true
},
"restart_required": {
"required": true,
"reason": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_type": "<string>"
}
}Get configuration
Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores.
A valid request URL is required to generate request examples{
"client_config": {
"drop_excess_requests": true,
"prometheus_labels": [
"<string>"
],
"allowed_origins": [
"<string>"
],
"initial_pool_size": 123,
"enable_logging": true,
"disable_content_logging": true,
"allow_per_request_content_storage_override": false,
"allow_per_request_raw_override": false,
"enforce_auth_on_inference": true,
"vk_rotation_cooldown": 0,
"enforce_governance_header": true,
"max_request_body_size_mb": 123,
"compat": {
"convert_text_to_chat": true,
"convert_chat_to_responses": true,
"should_drop_params": true,
"should_convert_params": false,
"azure_deepseek": false
},
"log_retention_days": 123,
"header_filter_config": {
"allowlist": [
"<string>"
],
"denylist": [
"<string>"
]
},
"mcp_agent_depth": 123,
"mcp_tool_execution_timeout": 123,
"mcp_tool_sync_interval": 1,
"mcp_code_mode_binding_level": "<string>",
"required_headers": [
"<string>"
],
"logging_headers": [
"<string>"
],
"mcp_external_client_url": "<string>",
"mcp_server_auth_mode": "headers",
"oauth2_server_config": {
"issuer_url": "<string>",
"auth_code_ttl": 300,
"access_token_ttl": 600,
"disable_vk_identity": false
}
},
"framework_config": {
"id": 123,
"pricing_url": "<string>",
"pricing_sync_interval": 123
},
"auth_config": {
"admin_username": "<string>",
"admin_password": "<string>",
"is_enabled": true,
"disable_auth_on_inference": true
},
"is_db_connected": true,
"is_cache_connected": true,
"is_logs_connected": true,
"proxy_config": {
"enabled": true,
"type": "http",
"url": "<string>",
"username": "<string>",
"password": "<string>",
"no_proxy": "<string>",
"timeout": 123,
"skip_tls_verify": true,
"enable_for_scim": true,
"enable_for_inference": true,
"enable_for_api": true
},
"restart_required": {
"required": true,
"reason": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>",
"error_type": "<string>"
}
}| Permission | Granted via |
|---|---|
| None | Any authenticated caller - exempt from RBAC |
Authorizations
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 ofBasicAuth).
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. See Required permissions for how permissions are derived and which endpoints are exempt.
Query Parameters
If true, fetch configuration directly from the database
true, false Response
Successful response
Configuration response
Client configuration
Show child attributes
Show child attributes
Framework configuration
Show child attributes
Show child attributes
Absent when no admin account has been configured yet (first-time setup). Once an admin account exists, this is always present. Available starting in Bifrost 2.0.0-prerelease3; earlier versions always returned this field.
Show child attributes
Show child attributes
Global proxy configuration
Show child attributes
Show child attributes
Restart required configuration
Show child attributes
Show child attributes
Was this page helpful?

