Удалить приложение

DELETE /v1/apps/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) string да Идентификатор приложения из создания или списка

Тело запроса не требуется — пустое тело допустимо.

Примеры

curl — личный ключ

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/apps/APP_ID \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/apps/APP_ID \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/apps/APP_ID', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
if (res.status === 204) {
  console.log('Удалено')
}

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/apps/APP_ID', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

Ответ

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

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

204 No Content (без тела)

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

409 — у парного ключа есть активные серверы:

JSON 
{
  "success": false,
  "error": {
    "code": "APP_HAS_ACTIVE_SERVERS",
    "message": "App key has active servers — rebind them first",
    "details": {
      "activeServerCount": 2,
      "userMessage": "Перепривяжите серверы к другому ключу перед удалением приложения",
      "servers": [
        { "id": "srv-1", "name": "app-abc12345" }
      ]
    }
  }
}

Ошибки

HTTP Код Описание
403 UNAUTHORIZED Ключ не принадлежит автору или владельцу приложения
404 APP_NOT_FOUND Приложения с указанным id нет. Повторное удаление того же id тоже возвращает этот код
409 APP_HAS_ACTIVE_SERVERS У парного ключа есть активные серверы — сначала перепривяжите их к другому ключу. В details — activeServerCount, userMessage, servers

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

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

  • Повторное удаление идемпотентно. Второй DELETE того же id возвращает 404 APP_NOT_FOUND — приложение уже скрыто мягким удалением. Это штатный ответ, а не сбой: повторный вызов безопасен.

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