Revoke API key

DELETE

/user/api-keys/{apiKeyId}

Revoke an API key. Revoked keys can no longer authenticate requests.

Authorizations

• bearerAuth

Parameters

Path Parameters

apiKeyId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Revoked API key

object

apiKey

required

object

id

required

string

accountId

required

string

name

required

string

prefix

required

string

last4

required

string

scopes

required

Array<string>

lastUsedAt

required

Any of:

string

string

null

null

expiresAt

required

Any of:

string

string

null

null

revokedAt

required

Any of:

string

string

null

null

createdAt

required

string

updatedAt

required

string

401

Unauthorized

403

Forbidden

404

Not found