Get available filter data

Returns the distinct values each filter dimension offers, drawn from the logs of roughly the last month.

GET /api/logs/filterdata

Error

A valid request URL is required to generate request examples

200

{
  "models": [
    "<string>"
  ],
  "selected_keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>",
      "models": [
        "<string>"
      ],
      "blacklisted_models": [
        "<string>"
      ],
      "weight": 123,
      "aliases": {},
      "azure_key_config": {
        "endpoint": "<string>",
        "api_version": "<string>",
        "client_id": "<string>",
        "client_secret": "<string>",
        "tenant_id": "<string>",
        "scopes": [
          "<string>"
        ]
      },
      "vertex_key_config": {
        "project_id": "<string>",
        "project_number": "<string>",
        "region": "<string>",
        "auth_credentials": "<string>",
        "force_single_region": false,
        "aws_workload_identity": {
          "audience": "<string>",
          "service_account_email": "<string>",
          "token_lifetime_seconds": 21900,
          "aws_region": "<string>",
          "aws_role_arn": "<string>"
        }
      },
      "bedrock_key_config": {
        "access_key": "<string>",
        "secret_key": "<string>",
        "session_token": "<string>",
        "region": "<string>",
        "arn": "<string>",
        "batch_s3_config": {
          "buckets": [
            {
              "bucket_name": "<string>",
              "prefix": "<string>",
              "is_default": true
            }
          ]
        }
      },
      "vllm_key_config": {
        "url": "<string>",
        "model_name": "<string>"
      },
      "ollama_key_config": {
        "url": "<string>"
      },
      "sgl_key_config": {
        "url": "<string>"
      },
      "cloudflare_key_config": {
        "account_id": "<string>"
      },
      "replicate_key_config": {
        "use_deployments_endpoint": true
      },
      "oauth_key_config": {
        "grant_type": "client_credentials",
        "token_url": "<string>",
        "client_id": "<string>",
        "client_secret": "<string>",
        "private_key": "<string>",
        "scopes": [
          "<string>"
        ],
        "audience": "<string>",
        "issuer": "<string>",
        "subject": "<string>",
        "key_id": "<string>",
        "signing_algorithm": "RS256",
        "auth_style": "header",
        "extra_params": {},
        "assertion_lifetime_seconds": 300
      },
      "enabled": true,
      "use_for_batch_api": true,
      "config_hash": "<string>",
      "status": "<string>",
      "description": "<string>"
    }
  ],
  "virtual_keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>",
      "is_active": true,
      "provider_configs": [
        {
          "id": 123,
          "virtual_key_id": "<string>",
          "provider": "<string>",
          "weight": 123,
          "allowed_models": [
            "<string>"
          ],
          "blacklisted_models": [
            "<string>"
          ],
          "allow_all_keys": true,
          "keys": [
            {
              "id": 123,
              "name": "<string>",
              "provider_id": 123,
              "provider": "<string>",
              "key_id": "<string>",
              "value": "<string>",
              "models": [
                "<string>"
              ],
              "weight": 123,
              "enabled": true,
              "use_for_batch_api": false,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "config_hash": "<string>",
              "azure_endpoint": "<string>",
              "azure_client_id": "<string>",
              "azure_client_secret": "<string>",
              "azure_tenant_id": "<string>",
              "vertex_project_id": "<string>",
              "vertex_project_number": "<string>",
              "vertex_region": "<string>",
              "vertex_auth_credentials": "<string>",
              "bedrock_access_key": "<string>",
              "bedrock_secret_key": "<string>",
              "bedrock_session_token": "<string>",
              "bedrock_region": "<string>",
              "bedrock_arn": "<string>"
            }
          ],
          "rate_limit_id": "<string>",
          "budgets": [
            {
              "id": "<string>",
              "max_limit": 123,
              "reset_duration": "<string>",
              "last_reset": "2023-11-07T05:31:56Z",
              "current_usage": 123,
              "config_hash": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "reset_config": {
                "quarter_start_month": 6
              },
              "override_amount": 123,
              "override_mode": "cycles",
              "override_cycles_remaining": 123,
              "override_cycles_total": 123,
              "override_anchor_reset": "2023-11-07T05:31:56Z",
              "team_id": "<string>",
              "virtual_key_id": "<string>",
              "provider_config_id": 123
            }
          ],
          "rate_limit": {
            "id": "<string>",
            "token_current_usage": 123,
            "token_last_reset": "2023-11-07T05:31:56Z",
            "request_current_usage": 123,
            "request_last_reset": "2023-11-07T05:31:56Z",
            "config_hash": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "token_max_limit": 123,
            "token_reset_duration": "<string>",
            "request_max_limit": 123,
            "request_reset_duration": "<string>"
          }
        }
      ],
      "mcp_configs": [
        {
          "id": 123,
          "virtual_key_id": "<string>",
          "mcp_client_id": 123,
          "mcp_client": {
            "client_id": "<string>",
            "name": "<string>",
            "is_code_mode_client": true,
            "connection_type": "http",
            "connection_string": "<string>",
            "stdio_config": {
              "command": "<string>",
              "args": [
                "<string>"
              ],
              "envs": [
                "<string>"
              ]
            },
            "tls_config": {
              "insecure_skip_verify": true,
              "ca_cert_pem": "<string>"
            },
            "auth_type": "none",
            "oauth_config_id": "<string>",
            "headers": {},
            "tools_to_execute": [
              "<string>"
            ],
            "tools_to_auto_execute": [
              "<string>"
            ],
            "tool_pricing": {},
            "allow_on_all_virtual_keys": false,
            "per_user_header_keys": [
              "<string>"
            ],
            "token_exchange": {
              "audience": "<string>",
              "use_idp_credentials": true,
              "client_id": "<string>",
              "client_secret": "<string>",
              "scopes": [
                "<string>"
              ],
              "authorization_server_url": "<string>"
            },
            "disabled": false,
            "require_public_target": false
          },
          "tools_to_execute": [
            "<string>"
          ]
        }
      ],
      "calendar_aligned": true,
      "config_hash": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "delete_after_expire": true,
      "previous_value_expires_at": "2023-11-07T05:31:56Z",
      "rotated_at": "2023-11-07T05:31:56Z",
      "team_id": "<string>",
      "customer_id": "<string>",
      "rate_limit_id": "<string>",
      "allow_all_providers": true,
      "disable_content_logging": true,
      "team": {
        "id": "<string>",
        "name": "<string>",
        "customer_id": "<string>",
        "customer": {
          "id": "<string>",
          "name": "<string>",
          "budget_id": "<string>",
          "budget": {
            "id": "<string>",
            "max_limit": 123,
            "reset_duration": "<string>",
            "last_reset": "2023-11-07T05:31:56Z",
            "current_usage": 123,
            "config_hash": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "reset_config": {
              "quarter_start_month": 6
            },
            "override_amount": 123,
            "override_mode": "cycles",
            "override_cycles_remaining": 123,
            "override_cycles_total": 123,
            "override_anchor_reset": "2023-11-07T05:31:56Z",
            "team_id": "<string>",
            "virtual_key_id": "<string>",
            "provider_config_id": 123
          },
          "teams": "<array>",
          "virtual_keys": "<array>",
          "virtual_key_count": 123,
          "config_hash": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "budgets": [
          {
            "id": "<string>",
            "max_limit": 123,
            "reset_duration": "<string>",
            "last_reset": "2023-11-07T05:31:56Z",
            "current_usage": 123,
            "config_hash": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "reset_config": {
              "quarter_start_month": 6
            },
            "override_amount": 123,
            "override_mode": "cycles",
            "override_cycles_remaining": 123,
            "override_cycles_total": 123,
            "override_anchor_reset": "2023-11-07T05:31:56Z",
            "team_id": "<string>",
            "virtual_key_id": "<string>",
            "provider_config_id": 123
          }
        ],
        "virtual_keys": "<array>",
        "profile": {},
        "config": {},
        "claims": {},
        "config_hash": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "customer": {
        "id": "<string>",
        "name": "<string>",
        "budget_id": "<string>",
        "budget": {
          "id": "<string>",
          "max_limit": 123,
          "reset_duration": "<string>",
          "last_reset": "2023-11-07T05:31:56Z",
          "current_usage": 123,
          "config_hash": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "reset_config": {
            "quarter_start_month": 6
          },
          "override_amount": 123,
          "override_mode": "cycles",
          "override_cycles_remaining": 123,
          "override_cycles_total": 123,
          "override_anchor_reset": "2023-11-07T05:31:56Z",
          "team_id": "<string>",
          "virtual_key_id": "<string>",
          "provider_config_id": 123
        },
        "teams": "<array>",
        "virtual_keys": "<array>",
        "virtual_key_count": 123,
        "config_hash": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "budgets": [
        {
          "id": "<string>",
          "max_limit": 123,
          "reset_duration": "<string>",
          "last_reset": "2023-11-07T05:31:56Z",
          "current_usage": 123,
          "config_hash": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "reset_config": {
            "quarter_start_month": 6
          },
          "override_amount": 123,
          "override_mode": "cycles",
          "override_cycles_remaining": 123,
          "override_cycles_total": 123,
          "override_anchor_reset": "2023-11-07T05:31:56Z",
          "team_id": "<string>",
          "virtual_key_id": "<string>",
          "provider_config_id": 123
        }
      ],
      "rate_limit": {
        "id": "<string>",
        "token_current_usage": 123,
        "token_last_reset": "2023-11-07T05:31:56Z",
        "request_current_usage": 123,
        "request_last_reset": "2023-11-07T05:31:56Z",
        "config_hash": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "token_max_limit": 123,
        "token_reset_duration": "<string>",
        "request_max_limit": 123,
        "request_reset_duration": "<string>"
      },
      "assigned_user": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "created_by_user_id": "<string>"
    }
  ],
  "routing_rules": [
    {
      "scope": "global",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "enabled": 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"
    }
  ],
  "routing_engines": [
    "<string>"
  ],
  "tool_call_names": [
    "<string>"
  ],
  "projects": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Required Permissions

Permission	Granted via
Logs: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

dimensions · string

Comma-separated dimensions to return. One or more of models, aliases, selected_keys, virtual_keys, routing_rules, routing_engines, stop_reasons, tool_call_names, apps, user_agents, teams, customers, users, business_units, projects, metadata_keys. Unrecognised values are ignored, and asking for none returns every dimension.

q · string

Free-text search within the requested dimensions. Passing it bypasses the response cache.

Response

200

application/json

Successful response

Available filter data response

models · string[]

selected_keys · object[]

Show child attributes

virtual_keys · object[]

Show child attributes

routing_rules · object[]

Available routing rules for filtering

CEL-based routing rule for intelligent request routing

Option 1

Option 2

Show child attributes

routing_engines · string[]

Available routing engine types (routing-rule, governance, loadbalancing)

tool_call_names · string[]

Function names that logged responses have called, for the tool calls filter. Read from the persisted tool_call_names metadata, so it stays available when message content is not logged or is offloaded in hybrid storage mode.

projects · object[]

Governance projects that appear in the logs, for the projects dimension. Only projects whose rows carry a name are listed.

Show child attributes