Документация Statusly API
Полное руководство по интеграции, настройке вебхуков и управлению мониторингом через код. Все, что нужно для подключения к платформе v2.
Быстрый старт
Создайте свой первый монитор за 30 секунд. Statusly API использует стандартные HTTP-запросы и JSON, поэтому вы можете начать работу с любого языка.
1. Получите API Key
Зайдите в Settings → API Keys и сгенерируйте токен с правами write:monitors.
2. Отправьте запрос
Используйте пример ниже, чтобы создать мониторинг доступности вашего сервиса.
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Production API',
url: 'https://api.example.com/health',
interval: 300 // 5 mins
})
});
{
"id": "mon_8f92a1",
"status": "active",
"created_at": "2023-10-27T10:00:00Z"
}
Методы API v2
RESTful интерфейс для управления всем жизненным циклом ваших сервисов.
Monitors
CRUD операции для создания и настройки чекеров. Поддержка HTTP, TCP, Ping и Script-based проверок.
POST /v2/monitors
GET /v2/monitors/:id
Incidents
Управление инцидентами. Создание статус-страниц, обновление прогресса и закрытие инцидентов программно.
POST /v2/incidents
PATCH /v2/incidents/:id
Subscribers
Подписка пользователей на обновления. Добавление email, Slack-каналов или Telegram-ботов через API.
POST /v2/subscribers
DELETE /v2/subscribers/:id
"event": "monitor.down",
"timestamp": "2023-10-27T14:30:00Z",
"data": {
"monitor_id": "mon_8f92a1",
"name": "Production API",
"latency": 1250,
"status_code": 503,
"error": "Connection Timed Out"
}
}
Формат Webhook
Настройте интеграцию с внутренними системами. Мы отправляем POST-запросы с полезной нагрузкой при каждом изменении статуса.
Типы событий
monitor.up— Сервис стал доступенmonitor.down— Сервис недоступенmonitor.latency_high— Высокий пинг (>2с)ssl.expiring_soon— Сертификат истекает (14д)
Установка агентов мониторинга
Для расширенного мониторинга (CPU, RAM, Disk IO) внутри вашего кластера, установите легковесный агент Statusly Agent.
Linux / Docker
Самый быстрый способ развертывания через Docker Compose или systemd.
Kubernetes
Используйте Helm-чарт для автоматического развертывания агентов на каждом ноде.
helm install statusly-agent statusly/agent