Get configuration

Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores.

GET /api/config

Error

A valid request URL is required to generate request examples

200

{
  "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,
    "extra_fields_placement": "body",
    "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,
      "force_reasoning_only_models_to_responses": true,
      "convert_decision_to_responses": false
    },
    "log_retention_days": 123,
    "delete_expired_virtual_keys": false,
    "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>",
    "mcp_max_instructions_per_client": 0,
    "mcp_max_instructions_total": 0,
    "mcp_oauth_private_allowlist": [
      "<string>"
    ],
    "a2a_private_allowlist": [
      "<string>"
    ],
    "mcp_code_mode_limits": {
      "max_source_bytes": 1,
      "max_steps": 1,
      "max_memory_bytes": 1,
      "max_log_bytes": 1,
      "max_tool_calls": 1,
      "max_value_bytes": 0,
      "max_nesting_depth": 500
    },
    "required_headers": [
      "<string>"
    ],
    "logging_headers": [
      "<string>"
    ],
    "a2a_external_client_url": "<string>",
    "skills_external_client_url": "<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,
      "allowed_redirect_uris": [
        "<string>"
      ],
      "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
  },
  "skills_marketplace_base_url": "<string>",
  "is_git_available": 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>"
  }
}

Required Permissions

Permission	Granted via
None	Any authenticated caller - exempt from RBAC

How permissions work

Authorizations

ManagementBearerAuthBasicAuth

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

from_db · enum<string>

If true, fetch configuration directly from the database

Available options: true, false

Response

200

application/json

Successful response

Configuration response

client_config · object

Client configuration

Show child attributes

framework_config · object

Framework configuration

Show child attributes

auth_config · object

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

skills_marketplace_base_url · string

Resolved public Skills Repository marketplace base URL. Empty when the URL is unset.

is_git_available · boolean

Whether Git is available on the Bifrost server for marketplace serving.

is_db_connected · boolean

is_cache_connected · boolean

is_logs_connected · boolean

proxy_config · object

Global proxy configuration

Show child attributes

restart_required · object

Restart required configuration

Show child attributes