К содержанию

Основные методы API

Список основных методов API: проверки, окна обслуживания, справочники и параметры создания проверки.

Обновлено 16 октября 2026 2 мин чтения

Все методы доступны по базовому адресу API. Ответ приходит в виде {"success": true, "data": …}. В ответах со списками есть блок meta, параметр per_page ограничен 250 записями.

Полное описание параметров находится в документации. Ссылка «Документация» есть в блоке «API-токены» в профиле.

Проверки

  • GET и POST /checks — список проверок и создание проверки.
  • GET, PUT и DELETE /checks/{id} — просмотр, изменение и удаление одной проверки.
  • POST /checks/{id}/pause и /resume — приостановить и возобновить.
  • POST /checks/{id}/pin и /unpin — закрепить и открепить.
  • POST /checks/{id}/recheck — запустить проверку сейчас.
  • GET /checks/{id}/overview, /results и /incidents — сводка, результаты и инциденты.

Окна обслуживания

  • GET и POST /maintenance-windows.
  • GET, PUT и DELETE /maintenance-windows/{id}.
  • POST /maintenance-windows/{id}/end — завершить окно.

Параметр repeat принимает значения none, daily или weekly. Для weekly передаётся weekdays с номерами дней от 1 до 7.

Справочники

  • GET /locations — список локаций.
  • GET, POST, PUT и DELETE для /contacts — контакты.
  • GET, POST, PUT и DELETE для /projects — проекты.

Создание проверки

Обязательные поля: project_name (если проекта нет, он создастся сам), type, address, frequency_in_min, пороги инцидента, expiration_notify_before_days, notification_delay_minutes и verify_ssl. Для порта обязателен port, для HEAD — expected_status_code.

Тип передаётся одним из значений: curl, icmp, head, port, certificate, domain, dns, ban, robots, trackers, content, xmlfeed, ymlfeed, realtyfeed, dnsbl, safe_browsing, seo, pagespeed, meta.

Локальные адреса не принимаются.

Статья помогла?
Спасибо за оценку!