key management

Delete Key Fn

Delete a key from the key management system.

Parameters::

  • keys (List[str]): A list of keys or hashed keys to delete. Example {"keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]}
  • key_aliases (List[str]): A list of key aliases to delete. Can be passed instead of keys.Example {"key_aliases": ["alias1", "alias2"]}

Returns:

  • deleted_keys (List[str]): A list of deleted keys. Example {"deleted_keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]}

Example:

curl --location 'http://0.0.0.0:4000/key/delete'     --header "Authorization: Bearer $LITELLM_MASTER_KEY"     --header 'Content-Type: application/json'     --data '{
    "keys": ["sk-QWrxEynunsNpV1zT48HIrw"]
}'

Raises: HTTPException: If an error occurs during key deletion.

post/key/delete

Request

  • Base URL: https://docs.litellm.com.cn (the document declares no server; this is the origin it was published from)
  • URL: https://docs.litellm.com.cn/key/delete
  • Auth: API key in header x-litellm-api-key

Headers

litellm-changed-bystring nullable

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

Request body

keysstring[] nullable
key_aliasesstring[] nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.