List routing rules

Returns a list of all routing rules configured for intelligent request routing across providers.

GET /api/routing/rules

Error

A valid request URL is required to generate request examples

200

{
  "rules": [
    {
      "scope": "global",
      "id": "<string>",
      "config_hash": "<string>",
      "name": "<string>",
      "description": "<string>",
      "enabled": true,
      "chain_rule": true,
      "cel_expression": "<string>",
      "targets": [
        {
          "weight": 0.5,
          "provider": "<string>",
          "model": "<string>",
          "key_id": "<string>",
          "ttft_timeout_ms": 150000
        }
      ],
      "fallbacks": [
        "<string>"
      ],
      "scope_id": "<string>",
      "priority": 123,
      "query": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123,
  "total_count": 123,
  "limit": 123,
  "offset": 123
}

Required Permissions

Permission	Granted via
RoutingRules:View	RBAC role or API key scope

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

scope · enum<string>

Filter by scope. Returns only enabled rules in that scope and ignores limit, offset and search. A scope other than global needs scope_id.

Available options: global, team, customer, virtual_key, user

scope_id · string

Filter by scope ID. Required with a scope other than global.

limit · integer · default: 25

Page size, 0 to 100 (default 25). Values above 100 are clamped to 100 without an error, and 0 uses the default, so read limit back from the response. Page with offset until offset >= total_count. Sending limit, offset or search returns one page; without them every rule is returned. Ignored when scope is set.

Required range: 0 <= x <= 100

offset · integer · default: 0

Number of rules to skip.

Required range: x >= 0

search · string

Case-insensitive match against the rule's name or CEL expression.

Response

200

application/json

Successful response

Response containing list of routing rules

rules · object[]

CEL-based routing rule for intelligent request routing

Option 1

Option 2

Show child attributes

count · integer

Number of routing rules returned

total_count · integer

Number of rules matching the filter before limit and offset

limit · integer

Page size applied (default 25, maximum 100). Without limit, offset or search, the number of rules returned.

offset · integer

Offset applied; 0 without limit, offset or search