Skip to main content
DELETE
/
api
/
v1
/
api-keys
/
{api_key_id}
Revoke API key
import requests

url = "https://api.example.com/api/v1/api-keys/{api_key_id}"

response = requests.delete(url)

print(response.text)
{
  "result": {},
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

​
X-API-Key
string | null

Path Parameters

​
api_key_id
string<uuid>
required

The UUID of the API key to revoke. You can retrieve this value by calling the List API keys operation.

Response

Successful Response

​
result
Result · object
required
​
success
boolean
default:true
​
suggestion
string
default:""
​
message
string
default:""
​
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.