Документация API и интеграции API-ключи: создание и управление

Зачем нужен API-ключ

API-ключ идентифицирует ваш аккаунт играничивает доступ. Каждый ключ привязан к конкретному типу использования.

Типы ключей

ТипНазначениеОграничение
CLIСерверные агенты мониторингаПо IP-адресу
WidgetВиджет на сайтеПо домену

Создание ключа

Для мониторинга серверов

  1. Раздел «API»«+ Создать проект»
  2. Укажите IP-адрес сервера (необязательно, для динамического IP — пусто)
  3. Нажмите «Создать»

Для виджета

  1. Раздел «Виджет»«Новый проект»
  2. Укажите домен сайта (обязательно)
  3. Нажмите «Создать»

Безопасность

  • Храните ключ в секрете
  • Не публикуйте в открытом коде или логах
  • Используйте IP-ограничения для CLI
  • Используйте доменные ограничения для виджета
  • При компрометации — удалите и создайте новый

Лимиты

ТарифМаксимум ключей
FREE5
PRO50+

REST API

Доступные эндпоинты:

  • GET /api/v1/monitoring/sites — список сайтов

  • POST /api/v1/monitoring/results — отправка результата

  • GET /api/v1/monitoring/tasks — задачи для агента

Аутентификация: заголовок X-API-Key: ВАШ_КЛЮЧ

Ограничение: 60 запросов в минуту.