Pomoc i poradnikiAPI i integracje › Przegląd endpointów API

Przegląd endpointów API

5 min czytania · API i integracje

Przegląd wszystkich dostępnych endpointów API. Base URL: https://epulz.io/api/v1

Autoryzacja: Authorization: Bearer plz_.... Limit 60 żądań na minutę na token. Token wygeneruj w Ustawienia -> Tokeny API.

Status / auth check

GET /status - weryfikuje token, zwraca email, plan, liczbę monitorów i otwarte incydenty

Monitors

GET /monitors - lista wszystkich Twoich monitorów (wraz z uptime 24h) GET /monitors/{id} - szczegóły jednego monitora POST /monitors - utwórz nowy monitor (JSON: name, type, target, interval_minutes, expected_status, expected_keyword) POST /monitors/bulk - import masowy (max 200 monitorów na żądanie) DELETE /monitors/{id} - usuń monitor (wraz z historią checków i incydentów)

Checks (historia)

GET /monitors/{id}/checks?limit=100 - ostatnich N kontroli (status, response time, status code, error, region). Limit 1-500, default 50.

Incidents

GET /incidents - lista incydentów. Opcjonalne filtry: monitor_id, resolved (true/false), limit (1-500, default 50).

Kody błędów

  • 401 - brak lub nieprawidłowy token
  • 403 - przekroczono limit monitorów planu (przy tworzeniu)
  • 404 - monitor nie należy do Ciebie lub nie istnieje
  • 429 - przekroczono rate limit (60 req/min)

Pełna specyfikacja OpenAPI

Specyfikacja maszynowa pod /api/openapi.json oraz interaktywna dokumentacja (Swagger UI) pod /api/docs. Obie wymagają logowania / tokena.