---
title: "Delete API key"
method: DELETE
path: "/apiKeys/{apiKeyId}"
tags: ["Settings"]
---

# Delete API key

`DELETE /apiKeys/{apiKeyId}`

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](https://docs.codat.io/platform-api#/schemas/apiKeys) 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](https://docs.codat.io/using-the-api/authentication) 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](https://app.codat.io/developers/api-keys) of the Portal.
* It is possible to delete the API key used to authenticate the *Delete API key* request.

## Path parameters

- `apiKeyId` string, required

## Response `204`

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

- ErrorMessage
  - `statusCode` integer — The HTTP status code returned by the error.
  - `service` string — Codat's service the returned the error.
  - `error` string — A brief description of the error.
  - `correlationId` string — Unique identifier used to propagate to all downstream services and determine the source of the error.
  - `validation` ErrorValidation — unresolved $ref
  - `canBeRetried` string — `True` if the error occurred transiently and can be retried.
  - `detailedErrorCode` integer — Machine readable error code used to automate processes based on the code returned.

## Other responses

- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.dev/codatio/apis/platform-api.md) · [All operations](https://skmtc.dev/codatio/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/platform-api/revisions/bff9b9776ecf/schema)
