Skip to content

docs(virtual_keys): document allowed_routes in default_key_generate_params #1477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(virtual_keys): document allowed_routes in default_key_generate_params #1477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/proxy/virtual_keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ litellm_settings:
### Default /key/generate params
Use this, if you need to control the default `max_budget` or any `key/generate` param per key.

When a `/key/generate` request does not specify `max_budget`, it will use the `max_budget` specified in `default_key_generate_params`. These defaults fill any field that is missing or `null` in the request. `budget_duration` is the one exception: sending an explicit `"budget_duration": null` creates a key whose budget never resets, skipping the configured default (`upperbound_key_generate_params` still applies).
When a `/key/generate` request does not specify `max_budget`, it will use the `max_budget` specified in `default_key_generate_params`. These defaults fill any field that is missing or `null` in the request. `budget_duration` is the one exception: sending an explicit `"budget_duration": null` creates a key whose budget never resets, skipping the configured default (`upperbound_key_generate_params` still applies). `allowed_routes` is applied the same way, so you can let every new key call `/key/spend/report` by setting it to `["llm_api_routes", "/key/spend/report"]`. A non-empty `allowed_routes` is an allowlist, so include the route groups the key still needs, and an explicit `key_type` preset on the request takes precedence.

Set `litellm_settings:default_key_generate_params`:
```yaml
Expand All @@ -665,6 +665,7 @@ litellm_settings:
duration: # blank means `null`
metadata: {"setting":"default"}
team_id: "core-infra"
allowed_routes: ["llm_api_routes", "/key/spend/report"]
```

### ✨ Key Rotations
Expand Down Expand Up @@ -904,4 +905,3 @@ class LitellmUserRoles(str, enum.Enum):




Loading