API status-страниц

Status-страницы публикуют актуальное состояние выбранных мониторов по публичному (или приватному) URL. Эта страница документирует публичный эндпоинт статуса, который любой клиент может читать без аутентификации, а также эндпоинты User API для получения списка и чтения ваших status-страниц.

Существует три различные поверхности, и они не используют один и тот же хост или схему аутентификации:

Сами status-страницы создаются и редактируются из дашборда, а не через API — User API предоставляет их только на чтение. См. Управление status-страницами.

Публичный эндпоинт статуса

GET /api/status/{slug}

Возвращает опубликованное состояние status-страницы, идентифицированной по её slug. Без аутентификации. Обслуживаются только страницы с is_public = true; приватный или неизвестный slug возвращает 404.

curl https://api.statusradar.dev/v1/status/my-status-page

Параметры пути

Поля ответа

Полезная нагрузка описывает страницу и мониторы, назначенные ей.

Объект theme

Объект monitors[]

Каждая запись монитора объединяет определение монитора с его настройками отображения для конкретной страницы и актуальным статусом.

Объект uptime_history[]

Пример ответа

{
  "slug": "my-status-page",
  "title": "Acme Status",
  "description": "Live status of the Acme platform.",
  "is_public": true,
  "language": "en",
  "show_history_days": 90,
  "theme": {
    "primary_color": "#10b981",
    "layout": "modern-light"
  },
  "overall_status": "operational",
  "monitors": [
    {
      "id": 42,
      "name": "API",
      "display_name": "Public API",
      "group_name": "Core",
      "current_status": "operational",
      "response_time_ms": 128,
      "last_check": "2026-06-23T09:14:02Z",
      "show_uptime": true,
      "show_response_time": true
    },
    {
      "id": 43,
      "name": "Website",
      "display_name": null,
      "group_name": "Core",
      "current_status": "down",
      "response_time_ms": null,
      "last_check": "2026-06-23T09:13:55Z",
      "show_uptime": true,
      "show_response_time": false
    }
  ],
  "incidents": [
    {
      "id": 9,
      "monitor_name": "Website",
      "title": "Elevated error rate",
      "status": "investigating",
      "severity": "major",
      "started_at": "2026-06-23T09:00:00Z"
    }
  ],
  "uptime_history": [
    { "date": "2026-06-22", "uptime": 100, "hasData": true },
    { "date": "2026-06-23", "uptime": 99.86, "hasData": true }
  ]
}

Когда любой назначенный монитор имеет статус down, overall_status становится partial, и группа этого монитора также отмечается как partial. В полезной нагрузке появляются только активные мониторы (is_active = true).

Ошибки

User API — Status-страницы

Эти эндпоинты требуют пользовательского API-токена. Сгенерируйте его в Dashboard → Settings → API (/dashboard/settings/api) и отправляйте как Bearer-токен. Результаты ограничены status-страницами, которыми владеют ваш аккаунт и команда. User API доступен только на чтение для status-страниц; создавайте и редактируйте их из дашборда.

Authorization: Bearer YOUR_API_TOKEN

Список status-страниц

GET /v1/status-pages

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.statusradar.dev/v1/status-pages

Возвращает status-страницы, принадлежащие вашей команде, включая как публичные, так и приватные страницы, каждая со своим slug, title, is_public, show_history_days, language, темой и количеством назначенных мониторов.

Получение status-страницы

GET /v1/status-pages/{id}

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.statusradar.dev/v1/status-pages/12

Возвращает отдельную status-страницу по числовому id с её полной конфигурацией и назначенными мониторами. Возвращает 404, если страница не существует или не принадлежит вашей команде.

Поля status-страницы

Эти поля определяют status-страницу. Они задаются в дашборде и предоставляются эндпоинтами выше.

Настройки отображения для каждого монитора

Когда вы назначаете монитор странице, эти настройки на каждое назначение управляют тем, как он отображается:

Управление status-страницами (Dashboard)

Создавайте и настраивайте status-страницы из дашборда — эти действия не предоставляются через Public/User API:

• Создать — Dashboard → Status Pages → Create (/dashboard/status-pages/create). Задайте title, slug, description, видимость, язык, окно истории и тему.
• Редактировать — /dashboard/status-pages/{slug}/edit.
• Назначить мониторы — /dashboard/status-pages/{slug}/manage-monitors. Выберите мониторы и задайте опции отображения для каждого монитора.
• Удалить — удаляет страницу и назначения её мониторов.

Создание status-страниц ограничено квотой status-страниц вашего тарифа; достижение лимита предложит апгрейд. См. Status-страницы.

URL публичной страницы

Каждая публичная status-страница также доступна для просмотра как HTML-страница по адресу:

https://statusradar.dev/status/{slug}

Это версия для людей тех же данных, которые возвращает GET /api/status/{slug} — поделитесь ею со своими пользователями. Приватные страницы возвращают 404 по этому URL.

Дальнейшие шаги

• Обзор API — полная поверхность API и базовые URL
• Аутентификация API — типы токенов и как их отправлять
• Status-страницы — создание и кастомизация status-страниц
• Мониторы — создание мониторов, которые вы назначаете странице
• Оповещения — оповещения, которые отображаются как инциденты на странице