Документация · API
REST API
Управляйте объектами, получайте метрики и инциденты, настраивайте вебхуки — без захода в интерфейс.
Базовый URL и авторизация
Ключи создаются в разделе «Настройки → API» и имеют области прав: monitors:read, monitors:write, incidents:read, reports:read, billing:read.
https://api.monitera.ru/v1
Authorization: Bearer mnt_live_9f2c...
Content-Type: application/json
Ресурсы
| Метод | Путь | Назначение |
|---|---|---|
| GET | /monitors | Список объектов с фильтрами |
| POST | /monitors | Создать объект |
| GET | /monitors/{id} | Карточка и текущий статус |
| PATCH | /monitors/{id} | Изменить настройки |
| POST | /monitors/{id}/check | Проверить сейчас (dry-run) |
| GET | /monitors/{id}/metrics | Метрики за период |
| GET | /incidents | Список инцидентов |
| POST | /incidents/{id}/acknowledge | Взять в работу |
| POST | /reports | Создать отчёт (async) |
| GET | /billing/balance | Баланс и прогноз |
Пример: создание объекта
curl -X POST https://api.monitera.ru/v1/monitors \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Интернет-магазин",
"target": "https://shop.example.com",
"checks": [{ "type": "http", "expected_codes": [200] }],
"schedule": { "interval_seconds": 300 }
}'
Ошибки
Ответ с ошибкой содержит type, title, status, detail и hint. Лимиты передаются в заголовках RateLimit-*, при превышении — 429 и Retry-After.
Частые вопросы
Нужно ли включать API в поддержке?
Нет, доступ включён по умолчанию; ключ создаётся самостоятельно в кабинете.
Есть ли песочница?
Да, отдельный базовый URL и ключи с префиксом test_.
Как проверяется подпись вебхука?
HMAC-SHA256 по телу запроса, заголовок X-Signature.