Delete

Delete Key Fn

post

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 sk-1234'     --header 'Content-Type: application/json'     --data '{
    "keys": ["sk-QWrxEynunsNpV1zT48HIrw"]
}'

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

Authorizations

APIKeyHeader

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

stringOptional

or

nullOptional

Body

keysany ofOptional

string[]Optional

or

nullOptional

key_aliasesany ofOptional

string[]Optional

or

nullOptional

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /key/delete HTTP/1.1
Host: 
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "keys": [
    "text"
  ],
  "key_aliases": [
    "text"
  ]
}

No content