Перейти к содержимому
WebShield Docs

API-токены

Программный доступ к API WebShield с ограниченными правами и привязкой к домену.

API-токены дают программный доступ к API (CI/CD, мониторинг, интеграции) без входа по логину. У токена настраиваемые права (скоупы) и опциональная привязка к одному домену.

Скоуп — это область:уровень. Запись включает чтение.

Область Уровни Что открывает
Домены чтение / запись список и управление доменами, делегирование
DNS чтение / запись DNS-записи домена
Проксирование чтение / запись проксирование и edge-конфигурация хостов
Сайты чтение / запись статические сайты (загрузка, публикация)
Поддержка чтение / запись тикеты поддержки
Защита форм чтение / запись проекты защиты форм и вызов скоринга
Аналитика чтение статистика домена
Биллинг чтение счета и потребление (без операций оплаты)

При создании токена можно выбрать один домен — тогда токен работает только с его ресурсами (DNS, проксирование, статика, аналитика, чтение биллинга этого домена). Запросы к другим доменам отклоняются. «Все домены» снимает ограничение в рамках выбранных скоупов. Поддержка не привязана к домену.

  1. Откройте Настройки → API-токены.
  2. Задайте название, выберите права, при необходимости домен и срок действия (пусто — бессрочный).
  3. Нажмите Создать токен. Полный токен (wsk_…) показывается один раз — сразу сохраните его.
  4. Отозвать токен можно кнопкой в списке; после отзыва он немедленно перестаёт действовать.

Токеном пользуется клиент командной строки — отдельно ничего настраивать не нужно, достаточно положить его в WS_TOKEN (или сохранить в профиль через webshield auth login):

Окно терминала
export WS_TOKEN=wsk_…
webshield domains list # нужен скоуп «Домены: чтение»
webshield dns add example.com www A 203.0.113.10 # нужен скоуп «DNS: запись»
webshield sites publish www.example.com --dir ./dist

Если у токена нет нужного скоупа или он привязан к другому домену, CLI сообщит об отказе (403); недействительный или истёкший токен — 401.