Delete an API key
DELETEhttps://api.vectara.io/v2/api_keys/:api_key_id
Delete API keys to help you manage the security and lifecycle of API keys in your application.
Request
Path Parameters
api_key_id stringrequired
The ID of the API key.
Header Parameters
Request-Timeout integer
Possible values: >= 1
The API will make a best effort to complete the request in the specified seconds or time out.
Request-Timeout-Millis integer
Possible values: >= 1
The API will make a best effort to complete the request in the specified milliseconds or time out.
Responses
- 204
- 403
The API key was deleted.
Permissions do not allow deleting this API key.
- application/json
- Schema
- Example (from schema)
Schema
messages message[]
The messages describing why the error occurred.
request_id string
The ID of the request that can be used to help Vectara support debug what went wrong.
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
Authorization: x-api-key
name: x-api-keytype: apiKeyin: header
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X DELETE 'https://api.vectara.io/v2/api_keys/:api_key_id' \
-H 'x-api-key: <API_KEY_VALUE>'
ResponseClear