Platitun · API · Access keys · Revoke a key

Revoke a key

DELETE /api/v1/keys/{id}

Key scope: keys · changes data, the Idempotency-Key header is required

The key stops working immediately. The record is NOT deleted: you must be able to see that the key existed and when it was revoked.

A key may revoke ITSELF: that is how a program that spotted a leak closes the door immediately without waiting for a human. The next request with that key is refused.

Response fields

Field	Type	What it is
`revoked`	`boolean`	Revoked.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

Code	What happened and what to do
`key_not_found`	No such key, or it has already been revoked.

Nearby in this section

GET /api/v1/keys — My access keys
POST /api/v1/keys — Issue a key