Sign in
Settings

Delete API key

Use the Delete API keys endpoint to delete an existing API key, providing its valid id as a parameter. Note that this operation is not reversible.

API keys are tokens used to control access to the API. Include this token in the Authorization header parameter when making API calls, following the word "Basic" and a space with your API key.

You can read more about authentication at Codat and managing API keys via the Portal UI or API.

Tips and pitfalls

  • It is possible to delete the last remaining API key. If this happens, a new key can be created via the API key management page of the Portal.
  • It is possible to delete the API key used to authenticate the Delete API key request.
delete/apiKeys/{apiKeyId}

Path parameters

apiKeyIdstring required
Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for api key.

Response

Too many requests were made in a given amount of time. Wait a short period and then try again.

statusCodeinteger

The HTTP status code returned by the error.

servicestring

Codat's service the returned the error.

errorstring

A brief description of the error.

correlationIdstring

Unique identifier used to propagate to all downstream services and determine the source of the error.

validationErrorValidation — unresolved $ref
canBeRetriedstring

True if the error occurred transiently and can be retried.

detailedErrorCodeinteger

Machine readable error code used to automate processes based on the code returned.

Changes