Platitun · API · Ключи доступа · Отозвать ключ

Отозвать ключ

DELETE /api/v1/keys/{id}

Область ключа: keys · изменяет данные, нужен заголовок Idempotency-Key

Ключ перестаёт работать немедленно. Запись НЕ удаляется: вы должны видеть, что ключ был и когда отозван.

Ключ вправе отозвать САМ СЕБЯ: так программа, заметившая утечку, закрывает дверь немедленно, не дожидаясь человека. Следующий запрос тем же ключом получит отказ.

Поля ответа

Поле	Тип	Что это
`revoked`	`boolean`	Отозван.

Поводы отказа

Отказ по правилам приходит как {"error":"rejected","refusal":{"kind":"…"}} с кодом 409. Общие для всех путей отказы — в разделе правил.

Код	Что случилось и что делать
`key_not_found`	Такого ключа нет или он уже отозван.

Рядом в этом разделе

GET /api/v1/keys — Свои ключи доступа
POST /api/v1/keys — Выдать ключ