Огляд API endpoints

Огляд усіх доступних ендпоінтів API (окремих URL-адрес REST API, до яких виконуються виклики). Базова URL: https://epulz.io/api/v1

Авторизація: надсилайте заголовок Authorization: Bearer epulzio_.... Ліміт запитів (rate limit) становить 60 запитів за хвилину на токен. Токен створюється в розділі Налаштування -> API-токени.

Статус / перевірка токена

• GET /status - перевіряє токен, повертає e-mail, тариф, кількість моніторів і кількість відкритих інцидентів.

Монітори

• GET /monitors - список усіх ваших моніторів (зокрема доступність за останні 24 год).
• GET /monitors/{id} - деталі одного монітора.
• POST /monitors - створює новий монітор. У тілі запиту (JSON) надішліть поля name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - масовий імпорт (щонайбільше 200 моніторів в одному запиті).
• PATCH /monitors/{id} - редагування наявного монітора (надсилайте лише поля, які хочете змінити).
• POST /monitors/{id}/check - запускає негайну перевірку поза запланованим інтервалом; повертає оновлений монітор.
• GET /monitors/{id}/uptime?days=30 - доступність у % за останні N днів (1-365, за замовчуванням 30); вікна обслуговування виключаються.
• DELETE /monitors/{id} - видаляє монітор (разом з історією перевірок та інцидентів).

Перевірки (історія)

• GET /monitors/{id}/checks?limit=100 - останні N перевірок монітора (стан, час відповіді, HTTP status code, можлива помилка, регіон). Параметр limit може бути від 1 до 500, за замовчуванням 50.

Інциденти

• GET /incidents - список інцидентів. Необов'язкові фільтри: monitor_id, resolved (true/false), limit (1-500, за замовчуванням 50).

Коди помилок

• 401 - відсутній або недійсний токен.
• 403 - перевищено ліміт моніторів вашого тарифу (під час створення).
• 404 - монітор вам не належить або не існує.
• 429 - перевищено ліміт запитів (60 за хвилину на токен).

Машиночитана документація

Повна специфікація у стандарті OpenAPI доступна за адресою /api/openapi.json. Інтерактивну документацію, де можна одразу випробувати ендпоінти (Swagger UI), ви знайдете за адресою /api/docs. Обидві потребують входу в систему або дійсного токена.