keys.archive
Stop a key.
Archiving immediately revokes the key. Any request using the key after archiving returns 401. Use Reactivate to restore access.
Reference
DELETE/api/v1/users/api-keys/{api_key_id}
- Auth
- API key in
X-API-Key - Content
- none
- Returns
- 200 · Response Archive Api Key Api V1 User Api Keys Api Key Id Delete
Archive an API key (soft delete).
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
api_key_id | path | integer | required |
Example request
curl -X DELETE "https://api.decibyl.ai/api/v1/users/api-keys/<api_key_id>" \
-H "X-API-Key: dcb_your_key"Response
{}Errors
| Status | When |
|---|---|
404 | Not found |
422 | Validation Error |