#Удалить файл

DELETE /v1/files/:id

Перемещает файл в корзину Битрикс24. Файл не удаляется навсегда — его можно восстановить средствами Битрикс24 вручную.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID файла. Целое число больше нуля

#Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/files/3291', {
  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/files/3291', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Файл перемещён в корзину')
}

#Ответ

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

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

HTTP/1.1 204 No Content

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

404 — файл не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Could not find entity with id '99999999'."
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Файл с указанным ID не найден
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING API-ключ не имеет настроенных токенов авторизации
401 INVALID_API_KEY Неверный или просроченный API-ключ

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

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

Операция перемещает файл в корзину Битрикс24 — мягкое удаление. Файл сохраняется в корзине и может быть восстановлен администратором портала через интерфейс Битрикс24. Безвозвратное удаление через API Вайбкода недоступно.

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