Revoke Api Key — DELETE /api/v1/keys/{key_id}
Revoke Api Key
Revoke (soft-delete) an API key: your own, or — as an ADMIN — anyone’s.
Endpoint: DELETE /api/v1/keys/{key_id}
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA engineer or higher.
- You must own this API key.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
key_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
204 | Successful Response | No body |
422 | Validation Error | HTTPValidationError (application/json) |
204 returns no body.
Errors this endpoint returns, read from its source code:
403404, with the message “API key not found”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: API Keys
- Operation ID:
revoke_api_key_api_v1_keys__key_id__delete - Source code:
backend/app/routers/api_keys.py, line 317 - Specification: OpenAPI JSON