Документация API

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

Базовый адрес

Все запросы к API выполняются по HTTPS на следующий адрес:

https://statuscheck.ru/api/v1

API использует версионирование в адресе. Текущая стабильная версия: v1.

Формат данных

API возвращает данные в формате JSON с кодировкой UTF-8. Для GET-запросов заголовок Content-Type не требуется.

Получение ключа API

Для работы с API необходим ключ. Получить его можно в личном кабинете:

  1. Войдите в личный кабинет
  2. Перейдите в раздел API в боковом меню
  3. Нажмите Создать ключ
  4. Скопируйте ключ и сохраните его в безопасном месте

Ключ API отображается только один раз при создании. Если вы потеряли ключ, создайте новый и удалите старый.

Уровни доступа

API доступен на тарифах Бизнес и Предприятие . Уровень доступа определяет набор доступных адресов:

Тариф Уровень Описание
Бизнес Базовый Чтение мониторов, инцидентов и предупреждений
Предприятие Полный Все адреса на чтение: мониторы, инциденты, предупреждения, история, метрики, уведомления, статус-страницы, сводка, подписка, команды и др.

Ключи API предоставляют только чтение данных. Операции создания, изменения и удаления через API недоступны.

Аутентификация

Все запросы к API должны содержать заголовок авторизации с вашим ключом:

X-API-Key: your-api-key

Пример запроса

curl -X GET "https://statuscheck.ru/api/v1/monitors" \
  -H "X-API-Key: sk_live_1234567890abcdef"

Ошибки аутентификации

При проблемах с аутентификацией API возвращает следующие ответы:

Код Описание Решение
401 Ключ API отсутствует или недействителен Проверьте наличие и корректность заголовка X-API-Key
403 Доступ запрещён Адрес недоступен на вашем тарифе или доступ к API не включён в план

Пример ответа с ошибкой

{
  "error": "Invalid or expired API key"
}

Адреса методов

Базовый доступ (Бизнес)

Доступно на тарифах Бизнес и Предприятие.

Метод Адрес Описание
GET /monitors Получить список всех мониторов
GET /monitors/{id} Получить монитор по идентификатору
GET /incidents Все инциденты
GET /incidents/open Текущие открытые инциденты
GET /incidents/{id} Детали инцидента по идентификатору
GET /monitors/{id}/incidents Инциденты конкретного монитора
GET /warnings Предупреждения SSL/DNS
GET /warnings/stats Статистика предупреждений
GET /warnings/{id} Детали предупреждения по идентификатору

Полный доступ (Предприятие)

Тариф Предприятие предоставляет доступ ко всем адресам API на чтение. Ниже перечислены основные из них:

Метод Адрес Описание
GET /monitors/{id}/history История проверок монитора
GET /monitors/{id}/metrics Метрики доступности и времени отклика
GET /monitors/{id}/uptime Данные о доступности монитора
GET /monitors/{id}/checks Детальные данные проверок
GET /monitors/{id}/checks/export Экспорт данных проверок
GET /subscription/usage Использование квот подписки
GET /notifications/channels Каналы уведомлений
GET /status-pages Статус-страницы
GET /dashboard/summary Сводка для главной панели
GET /dashboard/warnings Предупреждения для главной панели
GET /teams Список команд
GET /tickets Обращения в поддержку

Тариф Предприятие открывает доступ ко всем адресам системы на чтение, включая адреса для профиля, платежей и настроек. В таблице выше перечислены наиболее востребованные.

Примеры запросов

Получение списка мониторов

curl -X GET "https://statuscheck.ru/api/v1/monitors" \
  -H "X-API-Key: sk_live_1234567890abcdef"

Ответ ( 200)

{
  "monitors": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Production API",
      "monitor_type": "http",
      "url": "https://api.example.com/health",
      "enabled": true,
      "last_status": "up",
      "last_check_at": "2026-01-29T12:00:00Z",
      "last_response_time_ms": 142,
      "interval_seconds": 60,
      "region": "us-east"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Получение открытых инцидентов

curl -X GET "https://statuscheck.ru/api/v1/incidents/open" \
  -H "X-API-Key: sk_live_1234567890abcdef"

Получение предупреждений SSL/DNS

curl -X GET "https://statuscheck.ru/api/v1/warnings" \
  -H "X-API-Key: sk_live_1234567890abcdef"

Ограничение частоты запросов

API имеет ограничение на количество запросов для защиты от злоупотреблений: 5000 запросов в минуту на один IP-адрес. Лимит одинаков для всех тарифов.

При превышении лимита API вернёт ошибку 429 «Слишком много запросов» с заголовком Retry-After , указывающим, через сколько секунд можно повторить запрос.