Keys
Delete a key
Deleted keys are no longer valid and will not be able to be used to authenticate requests.
POST
Changelog
| Date | Changes |
|---|---|
| Dec 06 2023 | Introduced endpoint |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The id of the key to revoke
Minimum length:
1By 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 CONFLICT errors during key migration.
Response
200
application/json
The key was successfully revoked, it may take up to 30s for this to take effect in all regions
The response is of type object.
Was this page helpful?