Skip to main content

Блокировка и разблокировка публичной ссылки

Метод и конечная точка​

PUT /tenants/{tenant_name}/public_links/{link_key}

Описание​

Позволяет заблокировать и разблокировать указанную публичную ссылку.

Параметры​

Параметры для метода указаны в таблице.

НазваниеОбязательныйТип данныхОписание
enabledнетstringЗаблокировать / разблокировать публичную ссылку
tenant_nameдаstringИмя тенанта
link_keyдаstringИдентификатор (ключ) ссылки, может быть получен методом GET из предыдущего раздела

Запрос​

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/public_links/<LINK_KEY>?enabled=<ENABLED>" \
-H 'accept: application/json'

где:

  • <TENANT_NAME> — имя тенанта;

  • <LINK_KEY> — значение идентификатора (ключа) ссылки, параметра key, полученного методом GET из предыдущего раздела;

  • enabled=<ENABLED> — если параметр указан, то ссылка будет разблокирована (true) или заблокирована (false).

Ответ​

Возможные варианты ответов:

  • 200 — Success — Успешно. Пример вывода:
{
"message": "string"
}
  • 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}