A valid request URL is required to generate request examples{
"access_profile": {
"id": 123,
"name": "<string>",
"description": "<string>",
"is_active": true,
"version": 123,
"tags": [
"<string>"
],
"provider_configs": [
{
"provider_name": "<string>",
"id": 123,
"all_models_allowed": true,
"allowed_models": [
"<string>"
],
"budgets": [
{
"max_limit": 123,
"reset_duration": "1h",
"id": "<string>",
"reset_config": {
"quarter_start_month": 6
},
"scope": "<string>",
"current_usage": 123,
"last_reset": "2023-11-07T05:31:56Z"
}
],
"rate_limit": {
"id": "<string>",
"token_max_limit": 123,
"token_reset_duration": "1h",
"request_max_limit": 123,
"request_reset_duration": "1h",
"token_current_usage": 123,
"request_current_usage": 123
}
}
],
"budgets": [
{
"max_limit": 123,
"reset_duration": "1h",
"id": "<string>",
"reset_config": {
"quarter_start_month": 6
},
"scope": "<string>",
"current_usage": 123,
"last_reset": "2023-11-07T05:31:56Z"
}
],
"rate_limit": {
"id": "<string>",
"token_max_limit": 123,
"token_reset_duration": "1h",
"request_max_limit": 123,
"request_reset_duration": "1h",
"token_current_usage": 123,
"request_current_usage": 123
},
"calendar_aligned": true,
"allow_all_providers": true,
"auto_rotation_interval": 123,
"next_rotation_at": "2023-11-07T05:31:56Z",
"last_rotation_at": "2023-11-07T05:31:56Z",
"virtual_mcps": [
{
"virtual_mcp_name": "<string>",
"virtual_mcp_id": 2
}
],
"mcp_configs": [
{
"mcp_client_id": "<string>",
"tools_to_execute": [
"<string>"
]
}
],
"mcp_tool_groups": [
{
"tool_group_id": 123
}
],
"mcp_servers": [
{
"mcp_server_id": "<string>"
}
],
"mcp_tool_overrides": [
{
"mcp_client_id": "<string>",
"tool_name": "<string>",
"action": "include"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}{
"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>"
}
}Update access profile
Partial update. Omitted fields preserve the current value.
rate_limit: null explicitly clears the existing rate limit.
Size limits enforced: max 100 provider_configs, max 100 budgets, max 50 tags.
A valid request URL is required to generate request examples{
"access_profile": {
"id": 123,
"name": "<string>",
"description": "<string>",
"is_active": true,
"version": 123,
"tags": [
"<string>"
],
"provider_configs": [
{
"provider_name": "<string>",
"id": 123,
"all_models_allowed": true,
"allowed_models": [
"<string>"
],
"budgets": [
{
"max_limit": 123,
"reset_duration": "1h",
"id": "<string>",
"reset_config": {
"quarter_start_month": 6
},
"scope": "<string>",
"current_usage": 123,
"last_reset": "2023-11-07T05:31:56Z"
}
],
"rate_limit": {
"id": "<string>",
"token_max_limit": 123,
"token_reset_duration": "1h",
"request_max_limit": 123,
"request_reset_duration": "1h",
"token_current_usage": 123,
"request_current_usage": 123
}
}
],
"budgets": [
{
"max_limit": 123,
"reset_duration": "1h",
"id": "<string>",
"reset_config": {
"quarter_start_month": 6
},
"scope": "<string>",
"current_usage": 123,
"last_reset": "2023-11-07T05:31:56Z"
}
],
"rate_limit": {
"id": "<string>",
"token_max_limit": 123,
"token_reset_duration": "1h",
"request_max_limit": 123,
"request_reset_duration": "1h",
"token_current_usage": 123,
"request_current_usage": 123
},
"calendar_aligned": true,
"allow_all_providers": true,
"auto_rotation_interval": 123,
"next_rotation_at": "2023-11-07T05:31:56Z",
"last_rotation_at": "2023-11-07T05:31:56Z",
"virtual_mcps": [
{
"virtual_mcp_name": "<string>",
"virtual_mcp_id": 2
}
],
"mcp_configs": [
{
"mcp_client_id": "<string>",
"tools_to_execute": [
"<string>"
]
}
],
"mcp_tool_groups": [
{
"tool_group_id": 123
}
],
"mcp_servers": [
{
"mcp_server_id": "<string>"
}
],
"mcp_tool_overrides": [
{
"mcp_client_id": "<string>",
"tool_name": "<string>",
"action": "include"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}{
"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>"
}
}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.
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
Body
Partial update. Omitted fields preserve the current value.
rate_limit: null explicitly clears the existing rate limit; omitting the field preserves it.
Update enforces size limits not enforced on create: max 100 provider_configs, max 100 budgets, max 50 tags.
255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When true, grants access to every provider, including ones without a provider_configs entry and providers added later. A listed provider keeps its own model allow/blacklist, budgets, rate limits, and key selection; an unlisted provider gets all models, all keys, and no per-provider limits. When false, provider-wide access is disabled and access is deny-by-default via provider_configs. Omit to leave unchanged.
Replace the rotation schedule ("30d", "12h" or nanoseconds); "" or 0 turns it off. Omit to leave the schedule unchanged.
^$|^[0-9]+d$|^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"30d"
Override the next rotation time (must be in the future). null clears it, which is only valid when the interval is off. Omit to keep the existing schedule; a changed interval re-anchors it to now + interval.
A Virtual MCP granted to the profile. Assignments are a set, so a repeat collapses rather than doubling.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
DEPRECATED: use virtual_mcps.
Show child attributes
Show child attributes
DEPRECATED: use mcp_configs. Folded in on save.
Show child attributes
Show child attributes
DEPRECATED: use mcp_configs. Folded in on save.
Show child attributes
Show child attributes
Response
Profile updated
Show child attributes
Show child attributes
Was this page helpful?

