Skip to content

Revoke API key

DELETE
/v1/api-keys/{id}

Revoke one of the signed-in user's API keys immediately — any request using it fails auth from this point on. There's no undo; create a new key if you need a replacement. Requires an interactive login: a key can't revoke keys (403 interactive_auth_required).

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Parameters

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses

Forbidden

application/problem+json
Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI