Skip to main content

Archive API Key

DELETE/api/v1/user/api-keys/{api_key_id}

Archive an API key (soft delete).

cURL example

curl -X DELETE \
  'http://localhost:8000/api/v1/user/api-keys/{api_key_id}' \
  -H 'Authorization: Bearer <API_KEY>'

Parameters

NameLocationTypeDescription
api_key_idrequiredpathinteger
authorizationheaderobject
X-API-Keyheaderobject

Responses

200Successful Response
application/json
View schema
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Archive Api Key Api V1 User Api Keys  Api Key Id  Delete"
}
404Not found
422Validation Error
application/json
View schema
{
  "$ref": "#/components/schemas/HTTPValidationError"
}