Удалить навсегда папку

POST /v1/folders/:id/purge

Безвозвратно удаляет объект мимо корзины. Работает для живого объекта и объекта из корзины. Для удаления с возможностью вернуть используйте DELETE /v1/folders/:id.

Параметры

Скоуп ключа: disk. Тело не требуется.

curl

curl -X POST "https://vibecode.bitrix24.tech/v1/folders/42/purge" -H "X-Api-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://vibecode.bitrix24.tech/v1/folders/42/purge", {
  method: "POST",
  headers: { "X-Api-Key": "YOUR_API_KEY" },
});
const data = await response.json();

Ответ

{
  "success": true,
  "data": {
    "id": 42,
    "purged": true
  }
}

Ошибки

400 INVALID_ID / INVALID_PARAMS; 401 TOKEN_MISSING; 403 SCOPE_DENIED / BITRIX_ACCESS_DENIED / WRITE_BLOCKED_READONLY_KEY; 404 ENTITY_NOT_FOUND; 422 BITRIX_ERROR / DISK_DELETE_REFUSED; 429; 502 DISK_OUTCOME_UNKNOWN / BITRIX_UNAVAILABLE; 503.

READONLY-ключ не допускает действие. Отсутствующий объект и повторный purge возвращают 404.

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

Удаляет безвозвратно всё дерево. Права проверяются только на самой папке, вложенные объекты удаляются без отдельной проверки прав. Операция не транзакционна: при отказе часть содержимого могла быть уже удалена, перечитайте папку. Корень хранилища удалить нельзя.

Состояние корзины определяется только deletedType != 0: deletedAt и deletedBy после восстановления не очищаются. Автоматических повторов записи нет. При сетевом обрыве исход неизвестен: перечитайте объект, прежде чем повторять. Batch не поддерживает эти отдельные действия.

Bitrix24: disk.folder.deleteTree.

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

• DELETE
• Restore