---
title: "Revoke API key"
method: DELETE
path: "/v1/api-keys/{id}"
tags: ["api-keys"]
---

# Revoke API key

`DELETE /v1/api-keys/{id}`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/api-keys/{id}`
- Auth: HTTP bearer

Revokes an API key immediately, so it can no longer be used. You must hold the permission to delete keys at or above the location the key is pinned to, not merely somewhere else in the workspace.

**Notes.**
- The key stays in the list with `revokedAt` set. Revoking a key again answers 200 and moves `revokedAt` to now.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, required
    - `revoked` true, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You lack `api-key.delete` at the key's location.
- `404`: No such key in this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)