Block

Block Key

post

Block an Virtual key from making any requests.

Parameters:

  • key: str - The key to block. Can be either the unhashed key (sk-...) or the hashed key value

Example:

curl --location 'http://0.0.0.0:4000/key/block'     --header 'Authorization: Bearer sk-1234'     --header 'Content-Type: application/json'     --data '{
    "key": "sk-Fn8Ej39NxjAXrvpUGKghGw"
}'

Note: This is an admin-only endpoint. Only proxy admins can block keys.

Authorizations
Header parameters
litellm-changed-byany ofoptional

The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Body
keystringrequired
Responses
curl -L \
  --request POST \
  --url '/key/block' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "text"
  }'
{
  "token": "text",
  "key_name": "text",
  "key_alias": "text",
  "spend": 1,
  "max_budget": 1,
  "expires": "text",
  "models": [],
  "aliases": {},
  "config": {},
  "user_id": "text",
  "team_id": "text",
  "max_parallel_requests": 1,
  "metadata": {},
  "tpm_limit": 1,
  "rpm_limit": 1,
  "budget_duration": "text",
  "budget_reset_at": "2025-04-05T21:34:10.121Z",
  "allowed_cache_controls": [],
  "permissions": {},
  "model_spend": {},
  "model_max_budget": {},
  "soft_budget_cooldown": true,
  "blocked": true,
  "litellm_budget_table": {},
  "org_id": "text",
  "created_at": "2025-04-05T21:34:10.121Z",
  "created_by": "text",
  "updated_at": "2025-04-05T21:34:10.121Z",
  "updated_by": "text"
}

Successful Response

PreviousListNextUnblock