API endpoints overview

Overview of all available API endpoints (the individual REST API URLs you call). Base URL: https://epulz.io/api/v1

Authorization: send the header Authorization: Bearer epulzio_.... The rate limit is 60 requests per minute per token. You generate a token in Settings -> API tokens.

Status / token check

• GET /status - verifies the token, returns the e-mail, plan, number of monitors and number of open incidents.

Monitors

• GET /monitors - list of all your monitors (including uptime over the last 24 h).
• GET /monitors/{id} - detail of a single monitor.
• POST /monitors - creates a new monitor. In the request body (JSON) send the fields name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - bulk import (up to 200 monitors in a single request).
• PATCH /monitors/{id} - update an existing monitor (send only the fields you want to change).
• POST /monitors/{id}/check - runs an immediate check outside the scheduled interval; returns the updated monitor.
• GET /monitors/{id}/uptime?days=30 - uptime in % over the last N days (1-365, default 30); maintenance windows are excluded.
• DELETE /monitors/{id} - deletes the monitor (along with its check and incident history).

Checks (history)

• GET /monitors/{id}/checks?limit=100 - the last N checks of a monitor (status, response time, HTTP status code, any error, region). The limit parameter can be 1 to 500, default 50.

Incidents

• GET /incidents - list of incidents. Optional filters: monitor_id, resolved (true/false), limit (1-500, default 50).

Error codes

• 401 - missing or invalid token.
• 403 - monitor limit of your plan exceeded (when creating).
• 404 - the monitor does not belong to you or does not exist.
• 429 - request limit exceeded (60 per minute per token).

Machine-readable documentation

The complete specification in the OpenAPI standard is available at /api/openapi.json. Interactive documentation where you can try the endpoints directly (Swagger UI) can be found at /api/docs. Both require a login or a valid token.