DELETE /apikeys/{id}
Delete an API key
Deletes an API key with the specified ID. Only account administrators can delete API keys, and API keys cannot delete other API keys.
Authentication Required
Authorization: Bearer {token}
header string This header is required to access this endpoint
Required Parameters
id
path string The ID of the API key to delete
Optional Parameters
Click here to view an exhaustive list of all available parameters
x-account-id
header string The account ID for the request
Try it out
Loading...
Output:
Responses
Description
API key deleted successfully
{ "success": false}Description
Unauthorized - User not authenticated
Description
Forbidden - User does not have the required permissions
Description
ApiKey not found
{ "error": "API key not found"}Description
Internal server error
References
#/components/parameters/xAccountIdHeader
in: headername: x-account-idschema: type: stringdescription: The account ID for the requestrequired: false|export type xAccountIdHeader = any; // Schema type not fully supportedRoute Source Code
Check out the source code for this route entrypoint here: /apikeys/[id]/route.ts
Or the swagger.yaml spec this documentation was generated from:
/apikeys/swagger.yaml