Przegląd endpointów API

Przegląd wszystkich dostępnych endpointów API (poszczególnych adresów URL REST API, do których wysyłane są wywołania). Podstawowy URL: https://epulz.io/api/v1

Autoryzacja: wysyłaj nagłówek Authorization: Bearer epulzio_.... Limit żądań (rate limit) wynosi 60 żądań na minutę na token. Token wygenerujesz w Ustawieniach -> Tokeny API.

Status / sprawdzenie tokenu

• GET /status - weryfikuje token, zwraca e-mail, plan, liczbę monitorów i liczbę otwartych incydentów.

Monitory

• GET /monitors - lista wszystkich Twoich monitorów (wraz z dostępnością z ostatnich 24 h).
• GET /monitors/{id} - szczegóły pojedynczego monitora.
• POST /monitors - tworzy nowy monitor. W treści żądania (JSON) wyślij pola name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - import zbiorczy (maksymalnie 200 monitorów w jednym żądaniu).
• PATCH /monitors/{id} - edycja istniejącego monitora (wyślij tylko pola, które chcesz zmienić).
• POST /monitors/{id}/check - uruchamia natychmiastową kontrolę poza zaplanowanym interwałem; zwraca zaktualizowany monitor.
• GET /monitors/{id}/uptime?days=30 - dostępność w % za ostatnie N dni (1-365, domyślnie 30); okna konserwacji są wykluczone.
• DELETE /monitors/{id} - usuwa monitor (wraz z historią kontroli i incydentów).

Kontrole (historia)

• GET /monitors/{id}/checks?limit=100 - ostatnie N kontroli monitora (stan, czas odpowiedzi, HTTP status code, ewentualny błąd, region). Parametr limit może wynosić od 1 do 500, domyślnie 50.

Incydenty

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

Kody błędów

• 401 - brakujący lub nieprawidłowy token.
• 403 - przekroczony limit monitorów Twojego planu (przy tworzeniu).
• 404 - monitor nie należy do Ciebie lub nie istnieje.
• 429 - przekroczony limit żądań (60 na minutę na token).

Dokumentacja czytelna maszynowo

Pełna specyfikacja w standardzie OpenAPI jest dostępna pod /api/openapi.json. Interaktywną dokumentację, w której możesz bezpośrednio wypróbować endpointy (Swagger UI), znajdziesz pod /api/docs. Obie wymagają zalogowania lub ważnego tokenu.