POST
/
v1
/
keys.deleteKey

Changelog

DateChanges
Dec 06 2023Introduced endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
keyId
string
required

The id of the key to revoke

Minimum length: 1
permanent
boolean
default:
false

By default Unkey soft deletes keys, so they may be recovered later. If you want to permanently delete it, set permanent=true. This might be necessary if you run into NOT_UNIQUE errors during key migration.

Response

200 - application/json

The response is of type object.