Přehled API endpointů

Přehled všech dostupných API endpointů (jednotlivých URL adres REST API, na které se volá). Základní URL: https://epulz.io/api/v1

Autorizace: posílejte hlavičku Authorization: Bearer epulzio_.... Limit požadavků (rate limit) je 60 požadavků za minutu na token. Token vygenerujete v Nastavení -> API tokeny.

Status / kontrola tokenu

• GET /status - ověří token, vrátí e-mail, tarif, počet monitorů a počet otevřených incidentů.

Monitory

• GET /monitors - seznam všech vašich monitorů (včetně dostupnosti za posledních 24 h).
• GET /monitors/{id} - detail jednoho monitoru.
• POST /monitors - vytvoří nový monitor. V těle požadavku (JSON) pošlete pole name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - hromadný import (nejvýše 200 monitorů v jednom požadavku).
• PATCH /monitors/{id} - úprava stávajícího monitoru (pošlete jen pole, která chcete změnit).
• POST /monitors/{id}/check - spustí okamžitou kontrolu mimo plánovaný interval; vrátí aktualizovaný monitor.
• GET /monitors/{id}/uptime?days=30 - dostupnost v % za posledních N dní (1-365, výchozí 30); údržbová okna jsou vyloučena.
• DELETE /monitors/{id} - smaže monitor (spolu s historií kontrol a incidentů).

Kontroly (historie)

• GET /monitors/{id}/checks?limit=100 - posledních N kontrol monitoru (stav, čas odezvy, HTTP status code, případná chyba, region). Parametr limit může být 1 až 500, výchozí 50.

Incidenty

• GET /incidents - seznam incidentů. Volitelné filtry: monitor_id, resolved (true/false), limit (1-500, výchozí 50).

Chybové kódy

• 401 - chybějící nebo neplatný token.
• 403 - překročen limit monitorů vašeho tarifu (při vytváření).
• 404 - monitor vám nepatří nebo neexistuje.
• 429 - překročen limit požadavků (60 za minutu na token).

Strojově čitelná dokumentace

Kompletní specifikace ve standardu OpenAPI je dostupná na /api/openapi.json. Interaktivní dokumentaci, kde si můžete endpointy přímo vyzkoušet (Swagger UI), najdete na /api/docs. Obě vyžadují přihlášení nebo platný token.