Для AI-агентов: markdown этой страницы — /docs-content/management-keys/delete.md индекс документации — /llms.txt

Удалить API-ключ

DELETE /v1/keys/:id

Удаляет API-ключ владельца менеджмент-ключа и отзывает выписанные им токены доступа к серверам. Восстановить удалённый ключ через API нельзя — при необходимости создайте новый.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеИдентификатор записи ключа. Список: GET /v1/keys

Примеры

Запрос принимает только менеджмент-ключ — см. Ограничения.

curl — менеджмент-ключ

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc" \
  -H "X-Api-Key: YOUR_MANAGEMENT_KEY"

JavaScript — менеджмент-ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_MANAGEMENT_KEY',
  },
})

if (res.status === 204) {
  console.log('Ключ удалён')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, не содержимое.

Пример ответа

http 
HTTP/1.1 204 No Content

Пример ответа при ошибке

404 — ключ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "KEY_NOT_FOUND",
    "message": "API key not found"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодKEY_NOT_FOUND ОписаниеКлюча с таким id нет, он принадлежит другому пользователю или это менеджмент-ключ
HTTP409 КодKEY_HAS_ACTIVE_SERVERS ОписаниеКлючом управляются серверы. Перепривяжите их к другому ключу или удалите, затем повторите удаление. В error.details: activeServerCount — число серверов, servers — до 10 серверов с полями id, displayName, name, status. Поле userMessage — текст для человека
HTTP409 КодKEY_HAS_LINKED_AGENT ОписаниеКлючом управляется агент или управляемый бот. В error.details: linkedAgentCount, linkedBotCount — управляемые боты и обычные чат-боты вместе, agents — до 10 агентов с полями id, name, status, bots — до 10 обычных чат-ботов с полями botId и bitrixBotId, userMessage — текст для человека. Для DELETE /v1/bots/:botId берите числовой bitrixBotId из соответствующего элемента details.bots
HTTP409 КодKEY_BOT_CLEANUP_PENDING ОписаниеОбычный чат-бот этого ключа ещё не снят с портала. Ключ и бот остаются, повторите удаление позже
HTTP409 КодKEY_ROTATION_RECOVERY_REQUIRED ОписаниеКлюч — источник незавершённой замены: перевыпуск закончился ответом 500 или ещё выполняется
HTTP409 КодKEY_ROTATION_RECOVERY_REQUIRED ОписаниеКлюч — новый ключ незавершённой замены, и на него ещё что-то ссылается. Удаляется только новый ключ без ссылок, порядок — в Перевыпустить API-ключ. Если отказ пришёл на таком удалении, обратитесь в поддержку
HTTP409 КодKEY_REVOCATION_RECOVERY_PENDING ОписаниеОтзыв токенов доступа ключа ещё не завершён. Повторите удаление
HTTP409 КодREISSUE_IN_PROGRESS ОписаниеТолько ключ авторизации (vibe_app_): с ключом этого приложения уже идёт другая операция — перевыпуск, изменение или удаление. Повторите запрос после её завершения
HTTP409 КодKEY_NOT_ACTIVE ОписаниеКлюч авторизации (vibe_app_) удалили или изменили после начала запроса
HTTP409 КодKEY_NOT_ACTIVE ОписаниеВладелец, портал или приложение ключа сменились, пока выполнялось удаление. Перечитайте ключ через GET /v1/keys/:id
HTTP409 КодKEY_OPERATION_IN_PROGRESS ОписаниеС ключом уже идёт перенос или отзыв. Повторите удаление после его завершения
HTTP409 КодPORTAL_ORIGIN_CUTOVER_BUSY ОписаниеУ портала ключа меняется адрес. Повторите удаление позже
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНе удалось удалить учётные данные ключа в Битрикс24. Ключ не удалён
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеВыпуск ключа не был завершён, и удаление его вебхука в Битрикс24 не подтверждено. Ключ не удалён и продолжает занимать место в лимите ключей. Повторите удаление
HTTP503 КодPORTAL_ORIGIN_CUTOVER_UNAVAILABLE ОписаниеНе удалось проверить, меняется ли адрес портала ключа. Повторите удаление позже
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеМенеджмент-ключ, которым отправлен запрос, работает в режиме READONLY
HTTP403 КодMANAGEMENT_SCOPE_REQUIRED ОписаниеУ менеджмент-ключа нет скоупа vibe:mgmt:keys
HTTP401 КодWRONG_KEY_TYPE ОписаниеЗапрос отправлен ключом портала — личным vibe_api_ или ключом авторизации vibe_app_. Эндпоинт принимает только менеджмент-ключ
HTTP401 КодKEY_INACTIVE ОписаниеМенеджмент-ключ отозван или заблокирован
HTTP401 КодKEY_EXPIRED ОписаниеСрок действия менеджмент-ключа закончился
HTTP401 КодINVALID_API_KEY ОписаниеКлюч с переданным значением не найден
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key

Отказы OWNER_DELETED, OWNER_BLOCKED и ACCOUNT_PENDING_ERASURE зависят от аккаунта владельца ключа — см. Состояние аккаунта владельца.

Полный список общих ошибок API — Ошибки.

Известные особенности

Ключ с обычным чат-ботом сначала отзывается. Если ключом пользуется обычный чат-бот, удаление переводит ключ в REVOKED и снимает бота с портала, а запись ключа удаляет только после подтверждения. Ответ 409 KEY_BOT_CLEANUP_PENDING значит, что ключ уже отозван и в работу сам не вернётся.

Удаление работает и на замороженном аккаунте. Заморозка баланса не блокирует удаление ключа, в отличие от создания, изменения и перевыпуска.

Заблокированный ключ удаляется. Ключ в статусе BLOCKED удаляется так же, как остальные. Если на нём есть серверы, удаление ответит 409 KEY_HAS_ACTIVE_SERVERS — замените такой ключ перевыпуском, он переносит серверы на новый ключ.

Смотрите также