DELETE
/apikeys/{id}Delete an API key
Deletes an existing API key. Use the key's id to identify which credential to remove. A successful response confirms the operation.
idstringrequired
The unique identifier of the API key to delete.
200Returns an object containing an error field and a message confirming the operation.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when the request is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is unauthenticated.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the authenticated user is not permitted to delete the API key.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Returned when no API key exists with the given `id`.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
Error handling
A 400 is returned when the request is invalid, a 401 when the authenticated user does not present valid credentials, and a 403 when the authenticated user lacks permission to delete API keys. A 404 is returned when the key identified by the id path parameter cannot be found; a 500 indicates an internal server error.