Закрытие публичного доступа

Метод закрывает общий и персональный доступ к ресурсу по ранее созданной ссылке. Ресурс теряет атрибуты public_key и public_url, публичные ссылки на него перестают работать.

Важно

Закрыть доступ к ресурсу можно только с OAuth-токеном его владельца.

Необходимые права доступа для OAuth-приложения:

  • cloud_api:disk.read
  • cloud_api:disk.write
  • cloud_api:disk.app_folder

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

Метод: PUT.

https://cloud-api.yandex.net/v1/disk/resources/unpublish
 ? path=<путь к закрываемому ресурсу>

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

path*

Путь к закрываемому ресурсу. Например, %2Fbar%2Fphoto.png.

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

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

Authorization: OAuth <token>

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

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

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает ссылку на ресурс, в которому закрыли доступ, в теле ответа (в объекте Link).

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

{
  "href": "https://cloud-api.yandex.net/v1/disk/resources?path=disk%3A%2Fbar%2Fphoto.png",
  "method": "GET",
  "templated": false
}

Элемент

Описание

href

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

method

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

templated

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

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

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

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

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

  • 400 — Некорректный запрос.
  • 401 — Не авторизован.
  • 403 — API недоступно. Ваши файлы занимают больше места, чем у вас есть. Удалите лишнее или увеличьте объём Диска. / API недоступно. Диск в режиме "только чтение". Проверьте тариф вашей организации.
  • 404 — Не удалось найти запрошенный ресурс.
  • 423 — Технические работы. Сейчас можно только просматривать и скачивать файлы.
  • 423 — Ресурс заблокирован. Возможно, над ним выполняется другая операция.
  • 503 — Сервис временно недоступен.

Путь к закрываемому ресурсу. Например, %2Fbar%2Fphoto.png.

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

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