Отзыв API-ключа

DELETE /v1/api-keys/{id}

Немедленный отзыв API-ключа. После отзыва любые запросы с этим ключом будут отклонены с ошибкой 401 UNAUTHORIZED.

Попробуйте

Протестируйте этот эндпоинт интерактивно в Swagger UI.

Требуется авторизация

Укажите ваш API-ключ в заголовке Authorization.

DANGER

Отзыв ключа происходит немедленно и является необратимым. Все системы, использующие этот ключ, немедленно потеряют доступ. Это действие нельзя отменить -- вам потребуется создать новый ключ и обновить свои системы.

Запрос

Заголовки

Заголовок	Значение	Обязательно
Authorization	Bearer <token>	Да

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да	ID API-ключа для отзыва (например, ak_1a2b3c4d5e6f7g8h).

Примеры кода

curl

curl -X DELETE https://api.docmap.io/v1/api-keys/ak_1a2b3c4d5e6f7g8h \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY
const keyId = 'ak_1a2b3c4d5e6f7g8h'

const response = await fetch(
  `https://api.docmap.io/v1/api-keys/${keyId}`,
  {
    method: 'DELETE',
    headers: { 'Authorization': `Bearer ${apiKey}` },
  },
)

const result = await response.json()
console.log(result) // { success: true }

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
key_id = "ak_1a2b3c4d5e6f7g8h"

response = requests.delete(
    f"https://api.docmap.io/v1/api-keys/{key_id}",
    headers={"Authorization": f"Bearer {api_key}"},
)

print(response.json())  # {"success": True}

Ответ

Статус: 200 OK

Пример

{
  "success": true
}

Ошибки

Статус	Код	Описание
401	UNAUTHORIZED	Отсутствующий, недействительный или просроченный API-ключ / токен.
403	FORBIDDEN	API-ключ принадлежит другому пользователю. Вы можете отзывать только свои собственные ключи.
404	NOT_FOUND	API-ключ с указанным ID не найден.