Удаление файла или папки

Удалять файлы и папки на Диске пользователя можно, указывая путь к удаляемому ресурсу. Помните, что перемещение ресурсов в корзину никак не влияет на доступное место на Диске. Чтобы освободить место, следует также удалять ресурсы из корзины.

Формат запроса

Метод: DELETE.

https://cloud-api.yandex.net/v1/disk/resources
 ? path=<путь к удаляемому ресурсу>
 & [permanently=<признак безвозвратного удаления>]
 & [md5=<MD5 удаляемого файла>]
 & [force_async=<признак перезаписи>]
 & [fields=<свойства, которые нужно включить в ответ>]

Описание query-параметров

path*

Путь к удаляемому ресурсу. Например, $2Ffoo%2Fphoto.png.

Путь в значении параметра следует кодировать в URL-формате.

permanently

Признак безвозвратного удаления. Поддерживаемые значения:

  • false — удаляемый файл или папка перемещаются в Корзину (используется по умолчанию).
  • true — файл или папка удаляются без помещения в Корзину.
md5

MD5-хеш удаляемого файла. Используется для дополнительной проверки того, что удаляется именно тот файл, который был предназначен для удаления.

MD5-хеш для файла можно получить из ответа на запрос, который возвращает метаинформации о ресурсе.

force_async

Параметр указывает на возможность асинхронного выполнения операции.

Допустимые значения:

  • false — операция не является асинхронной: следующий запрос можно отправлять только тогда, когда выполнен предыдущий.
  • true — асинхронная операция: следующий запрос можно отправлять, не дожидаясь выполнения предыдущего.
fields
Список свойств JSON, которые следует включить в ответ. Ключи, не указанные в этом списке, будут отброшены при составлении ответа. Если параметр не указан, ответ возвращается полностью, без сокращений.

Имена ключей следует указывать через запятую, а вложенные ключи разделять точками. Например: name,_embedded.items.path.

* Обязательный параметр.

Authorization: OAuth <token>

Формат ответа

Успешный ответ

Если запрос был обработан без ошибок, API составляет тело ответа в зависимости от вида указанного ресурса — ответ для пустой папки или файла отличается от ответа для непустой папки.

Файл или пустая папка

API отвечает кодом 204 No content (ресурс успешно удален) без тела ответа.

Непустая папка

Непустая папка может удаляться в течение произвольного времени, поэтому API отвечает кодом 202 Accepted (удаление папки начато).

Приложения должны самостоятельно следить за статусами запрошенных операций. API возвращает ссылку на статус запущенной по запросу операции в теле ответа в объекте Link.

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

{
  "href": "https://cloud-api.yandex.net/v1/disk/operations?id=d80c269ce4eb16c0207f0a15t4a31415313452f9e950cd9576f36b1146ee0e42",
  "method": "GET",
  "templated": false
}

Описание элементов ответа

Элемент

Описание

href

URL. Может быть шаблонизирован, см. ключ templated.

method

HTTP-метод для запроса URL из ключа href.

templated

Признак URL, который был шаблонизирован согласно RFC 6570. Возможные значения:

  • «true» — URL шаблонизирован: прежде чем отправлять запрос на этот адрес, следует указать нужные значения параметров вместо значений в фигурных скобках.
  • «false» — URL может быть запрошен без изменений.

Ответ с ошибкой

Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

Некоторые возможные ошибки:

  • 400 — Проверка md5 возможна только для файлов.
  • 401 — Не авторизован.
  • 403 — Недостаточно прав для изменения данных в общей папке.
  • 404 — Не удалось найти запрошенный ресурс.
  • 406 — Ресурс не может быть представлен в запрошенном формате.
  • 423 — Технические работы. Сейчас можно только просматривать и скачивать файлы.
  • 429 — Слишком много запросов.
  • 503 — Сервис временно недоступен.

Путь к удаляемому ресурсу. Например, $2Ffoo%2Fphoto.png.

Путь в значении параметра следует кодировать в URL-формате.

Признак безвозвратного удаления. Поддерживаемые значения:

  • false — удаляемый файл или папка перемещаются в Корзину (используется по умолчанию).
  • true — файл или папка удаляются без помещения в Корзину.

MD5-хеш удаляемого файла. Используется для дополнительной проверки того, что удаляется именно тот файл, который был предназначен для удаления.

MD5-хеш для файла можно получить из ответа на запрос, который возвращает метаинформации о ресурсе.

Параметр указывает на возможность асинхронного выполнения операции.

Допустимые значения:

  • false — операция не является асинхронной: следующий запрос можно отправлять только тогда, когда выполнен предыдущий.
  • true — асинхронная операция: следующий запрос можно отправлять, не дожидаясь выполнения предыдущего.

Список свойств JSON, которые следует включить в ответ. Ключи, не указанные в этом списке, будут отброшены при составлении ответа. Если параметр не указан, ответ возвращается полностью, без сокращений.

Имена ключей следует указывать через запятую, а вложенные ключи разделять точками. Например: name,_embedded.items.path.

Обязательный параметр.