Огляд API endpoints | Довідка та інструкції ePulz.io

Огляд API endpoints

5 хв читання · API та інтеграції

Довідник усіх доступних API ендпоінтів. Base URL: https://epulz.io/api/v1

Авторизація: Authorization: Bearer plz_.... Rate limit 60 запитів за хвилину на токен. Згенеруйте токен у Налаштування -> API токени.

Status / auth check

GET /status - перевіряє токен, повертає email, план, кількість моніторів та відкриті інциденти

Monitors

GET /monitors - список усіх ваших моніторів (з uptime за 24г) GET /monitors/{id} - деталі одного монітора POST /monitors - створити новий монітор (JSON: name, type, target, interval_minutes, expected_status, expected_keyword) POST /monitors/bulk - масовий імпорт (макс 200 моніторів за запит) DELETE /monitors/{id} - видалити монітор (разом з історією перевірок та інцидентами)

Примітка: оновлення існуючого монітора (PATCH) наразі недоступне через API. Використовуйте UI дашборда або видаліть і створіть монітор заново.

Checks (історія)

GET /monitors/{id}/checks?limit=100 - останні N перевірок (status, response time, status code, error, region). Limit 1-500, default 50.

Incidents

GET /incidents - список інцидентів. Опціональні фільтри: monitor_id, resolved (true/false), limit (1-500, default 50).

Коди помилок

401 - відсутній або недійсний токен
403 - перевищено ліміт моніторів плану (при створенні)
404 - монітор вам не належить або не існує
429 - перевищено rate limit (60 req/min)

Повна OpenAPI специфікація

Машиночитана специфікація на /api/openapi.json та інтерактивна документація (Swagger UI) на /api/docs. Обидві потребують входу / токена.