Create access profile (deprecated path)

Creates a new access profile template. The profile is inactive until attached to a role. No size limits are enforced on create; the limits apply on update.

POST /api/access-profiles

Error

A valid request URL is required to generate request examples

201

{
  "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",
    "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"
  }
}

This path is deprecated and will be removed in the following major release. Use /api/governance/access-profiles instead.

This endpoint is available in Bifrost Enterprise only.

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.

Body

application/json

name · string · required

Maximum string length: 255

description · string

tags · string[]

provider_configs · object[]

Show child attributes

budgets · object[]

Show child attributes

rate_limit · object

Show child attributes

calendar_aligned · boolean

allow_all_providers · boolean · default: false

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 (default), access is deny-by-default via provider_configs.

auto_rotation_interval · Option 1 · string Option 2 · integer<int64> Option 3 · integer<int64>

Schedule automatic rotation of the profile's managed virtual keys. Accepts a day count ("30d"), a Go duration ("12h"), or integer nanoseconds. Between 1h and 365d; omit, "" or 0 to leave it off.

Pattern: ^$|^[0-9]+d$|^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$

Example:

"30d"

next_rotation_at · string<date-time>

Optional first rotation time; must be in the future and requires auto_rotation_interval. Defaults to now + interval.

mcp_tool_groups · object[]

Show child attributes

mcp_servers · object[]

Show child attributes

mcp_tool_overrides · object[]

Show child attributes

Response

201

application/json

Profile created

access_profile · object

Show child attributes