API Endpoints Reference

Overview of available API endpoints and their usage.

API Endpoints Reference

Sites

Method — Endpoint — Description —

GET — /api/v1/sites — List all monitored sites —

GET — /api/v1/sites/:id — Get site details —

POST — /api/v1/sites — Add a new site —

PUT — /api/v1/sites/:id — Update site settings —

DELETE — /api/v1/sites/:id — Remove a site —

Checks

Method — Endpoint — Description —

GET — /api/v1/sites/:id/checks — List check results —

POST — /api/v1/sites/:id/checks — Trigger a new check —

GET — /api/v1/sites/:id/uptime — Get uptime data —

Reports

Method — Endpoint — Description —

GET — /api/v1/sites/:id/report — Generate a report —

GET — /api/v1/sites/:id/export — Export data (CSV/JSON) —

Alerts

Method — Endpoint — Description —

GET — /api/v1/alerts — List all alerts —

PUT — /api/v1/alerts/:id/acknowledge — Acknowledge an alert —

Pagination

All list endpoints support pagination:

Response Format

All responses follow a consistent JSON structure: