Skip to navigation
API KeyAPI Key Management

Delete API Key

Delete an API key. Superadmins only. The key stops working immediately.

key_id is the key’s id from GET /api-keys, not the key value itself. Passing a key value returns a 400.

Authenticate with Basic Auth (your Coperniq email and password), not an API key.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

key_idstringRequiredformat: "^key_[0-9a-f]{24}$"

The key’s id from GET /api-keys

Query parameters

company_idintegerOptional>=1

ID of the company to manage. Needed only when the authenticated user belongs to more than one company and the default (their first non-collaborator company) is not the one you want. You must be a superadmin in that company. Your company ID can be found in the URL after logging in to the Coperniq UI: https://app.coperniq.io/{company_id}/inbox.

Response

The key was deleted
successbooleanOptional
idstringOptional
The deleted key's ID
dbDeletedbooleanOptional
The key was deleted in Coperniq. This is what stops it from working.
awsDeletedbooleanOptional

The key was removed from the API gateway. false means there was no gateway key to remove (for example, it had already been removed); the key still no longer works, because dbDeleted is true.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error