> ## Documentation Index > Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update routing rule > Updates an existing routing rule's configuration. ## OpenAPI ````yaml /openapi/openapi.json put /api/governance/routing-rules/{rule_id} openapi: 3.1.0 info: title: Bifrost API description: > Bifrost HTTP Transport API for AI model inference and gateway management. This API provides a unified interface for interacting with multiple AI providers including OpenAI, Anthropic, Bedrock, Gemini, and more through a single API, along with comprehensive management APIs for configuring and monitoring the gateway. ## API Structure ### Unified Inference API (`/v1/*`) The primary API using Bifrost's unified format. Model parameters use the format `provider/model` (e.g., `openai/gpt-4`, `anthropic/claude-3-opus`). ### Async Inference API (`/v1/async/*`) Submit inference requests for asynchronous execution. Returns a job ID immediately and allows polling for results. Supports all inference types except batches, files, and containers. ### Provider Integration APIs Native provider-format APIs for drop-in compatibility: - `/openai/*` - OpenAI-compatible API - `/anthropic/*` - Anthropic-compatible API - `/genai/*` - Google GenAI (Gemini) compatible API - `/bedrock/*` - AWS Bedrock compatible API - `/cohere/*` - Cohere compatible API ### Framework Integration APIs Multi-provider proxy endpoints for AI frameworks: - `/litellm/*` - LiteLLM proxy with all provider formats - `/langchain/*` - LangChain compatible endpoints - `/pydanticai/*` - PydanticAI compatible endpoints ### Management APIs (`/api/*`) APIs for managing and monitoring the Bifrost gateway: - `/api/config` - Configuration management - `/api/providers` - Provider and API key management - `/api/plugins` - Plugin management - `/api/governance/*` - Virtual keys, teams, customers, budgets, rate limits, routing rules, and pricing overrides - `/api/logs` - Log search and analytics - `/api/mcp/*` - MCP (Model Context Protocol) client management - `/api/session/*` - Authentication and session management - `/api/cache/*` - Cache management - `/health` - Health check endpoint ## Fallbacks Requests can include fallback models that will be tried if the primary model fails. version: 1.0.0 contact: name: Contact Us url: https://getmaxim.ai/bifrost license: name: Apache 2.0 url: https://opensource.org/licenses/Apache-2.0 servers: - url: '{baseUrl}' description: Your Bifrost instance variables: baseUrl: default: http://localhost:8080 description: Base URL of your Bifrost instance (e.g. https://bifrost.mycompany.com) security: - BearerAuth: [] - BasicAuth: [] - ApiKeyAuth: [] tags: - name: Models description: Model listing and information - name: Chat Completions description: Chat-based text generation - name: Text Completions description: Text completion generation - name: Responses description: OpenAI Responses API compatible endpoints - name: OCR description: Optical character recognition for documents and images - name: Rerank description: Document reranking by relevance to a query - name: Embeddings description: Text embedding generation - name: Images description: Image generations, editing, and variations - name: Videos description: Video generation and management - name: Audio description: Speech synthesis and transcription - name: Count Tokens description: Token counting utilities - name: Batch description: Batch processing operations - name: Files description: File management operations - name: Containers description: Container management operations - name: Async Jobs description: Asynchronous job submission and retrieval endpoints - name: OpenAI Integration description: OpenAI-compatible API endpoints (/openai/*) - name: Azure Integration description: Azure OpenAI integration endpoints - name: Anthropic Integration description: Anthropic-compatible API endpoints (/anthropic/*) - name: GenAI Integration description: Google GenAI (Gemini) compatible API endpoints (/genai/*) - name: Bedrock Integration description: AWS Bedrock compatible API endpoints (/bedrock/*) - name: Cohere Integration description: Cohere compatible API endpoints (/cohere/*) - name: LiteLLM Integration description: LiteLLM proxy endpoints with multi-provider support (/litellm/*) - name: LangChain Integration description: LangChain compatible endpoints with multi-provider support (/langchain/*) - name: PydanticAI Integration description: >- PydanticAI compatible endpoints with multi-provider support (/pydanticai/*) - name: Health description: Health check endpoints - name: Configuration description: Configuration management endpoints - name: Session description: Session and authentication endpoints - name: Providers description: Provider management endpoints - name: Plugins description: Plugin management endpoints - name: MCP description: Model Context Protocol endpoints - name: Governance description: Virtual keys, teams, and customers management - name: Logging description: Log search and management endpoints - name: Cache description: Cache management endpoints paths: /api/governance/routing-rules/{rule_id}: put: tags: - Governance summary: Update routing rule description: Updates an existing routing rule's configuration. operationId: updateRoutingRule parameters: - name: rule_id in: path required: true description: Routing rule ID schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRoutingRuleRequest' responses: '200': description: Routing rule updated successfully content: application/json: schema: $ref: '#/components/schemas/RoutingRuleResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BifrostError' '404': description: Routing rule not found content: application/json: schema: $ref: '#/components/schemas/BifrostError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/BifrostError' components: schemas: UpdateRoutingRuleRequest: type: object description: >- Request to update a routing rule (all fields optional; providing `targets` replaces all existing targets) properties: name: type: string description: type: string enabled: type: boolean cel_expression: type: string targets: type: array minItems: 1 description: Replaces all existing targets when provided; weights must sum to 1 items: type: object description: A single weighted routing target within a routing rule required: - weight dependentRequired: key_id: - provider properties: provider: type: string description: >- Target provider (omit or empty to use the incoming request provider) nullable: true model: type: string description: Target model (omit or empty to use the incoming request model) nullable: true key_id: type: string description: >- UUID of the API key to pin for this target (omit for load-balanced key selection) nullable: true weight: type: number format: double exclusiveMinimum: 0 description: >- Probability weight for this target (must be > 0; all target weights in a rule must sum to 1, e.g. 0.7 + 0.3 = 1.0) example: 0.5 fallbacks: type: array items: type: string priority: type: integer query: type: object nullable: true RoutingRuleResponse: type: object description: Response containing created/updated routing rule properties: message: type: string rule: $ref: '#/components/schemas/RoutingRule' BifrostError: type: object description: Error response from Bifrost properties: event_id: type: string type: type: string is_bifrost_error: type: boolean status_code: type: integer error: $ref: '#/components/schemas/ErrorField' extra_fields: $ref: '#/components/schemas/BifrostErrorExtraFields' RoutingRule: type: object description: CEL-based routing rule for intelligent request routing properties: id: type: string description: Unique identifier for the routing rule name: type: string description: Name of the routing rule description: type: string description: Description of what the rule does enabled: type: boolean description: Whether the rule is enabled and active cel_expression: type: string description: CEL (Common Expression Language) expression for matching targets: type: array description: >- Weighted routing targets; weights must sum to 1; target is selected probabilistically at request time items: type: object description: A single weighted routing target within a routing rule required: - weight dependentRequired: key_id: - provider properties: provider: type: string description: >- Target provider (omit or empty to use the incoming request provider) nullable: true model: type: string description: Target model (omit or empty to use the incoming request model) nullable: true key_id: type: string description: >- UUID of the API key to pin for this target (omit for load-balanced key selection) nullable: true weight: type: number format: double exclusiveMinimum: 0 description: >- Probability weight for this target (must be > 0; all target weights in a rule must sum to 1, e.g. 0.7 + 0.3 = 1.0) example: 0.5 fallbacks: type: array items: type: string description: Fallback providers in format "provider/model" scope: type: string enum: - global - team - customer - virtual_key description: Scope level for the rule scope_id: type: string description: ID for the scope (empty for global scope) nullable: true priority: type: integer description: Priority for rule evaluation (lower number = higher priority) query: type: object description: Visual rule tree structure from query builder nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time oneOf: - type: object properties: scope: type: string enum: - global required: - scope description: Global scope routing rule - type: object properties: scope: type: string enum: - team - customer - virtual_key scope_id: type: string required: - scope - scope_id description: Scoped routing rule (requires scope_id) ErrorField: type: object properties: type: type: string code: type: string message: type: string param: type: string event_id: type: string BifrostErrorExtraFields: type: object properties: provider: $ref: '#/components/schemas/ModelProvider' model_requested: type: string request_type: type: string ModelProvider: type: string description: AI model provider identifier enum: - openai - azure - anthropic - bedrock - cohere - vertex - vllm - mistral - ollama - groq - sgl - parasail - perplexity - replicate - cerebras - gemini - openrouter - elevenlabs - huggingface - nebius - xai - runway - fireworks securitySchemes: BearerAuth: type: http scheme: bearer description: > Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with `sk-bf-`) can also be passed here. BasicAuth: type: http scheme: basic description: | Basic authentication using username and password. ApiKeyAuth: type: apiKey in: header name: x-api-key description: | API key authentication via the `x-api-key` header. Virtual keys (prefixed with `sk-bf-`) can also be passed here. ````