Обзор 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. Обе требуют входа в систему или действительного токена.