Súgó és útmutatókAPI és integrációk › API endpointok áttekintése

API endpointok áttekintése

5 perc olvasás · API és integrációk

Az összes elérhető API-végpont (a REST API egyes URL-címeinek, amelyeket meghívsz) áttekintése. Alap-URL: https://epulz.io/api/v1

Hitelesítés: küldd a Authorization: Bearer epulzio_... fejlécet. A kérések korlátja (rate limit) percenként 60 kérés tokenenként. A tokent a Beállítások -> API-tokenek menüpontban generálhatod.

API-tokenek kezelése a REST API eléréséhez
Az API-hívásokhoz használt tokent az API-tokenek szakaszban hozhatod létre és kezelheted.

Állapot / token ellenőrzése

  • GET /status - ellenőrzi a tokent, visszaadja az e-mailt, a csomagot, a monitorok számát és a nyitott incidensek számát.

Monitorok

  • GET /monitors - az összes monitorod listája (az elmúlt 24 órás rendelkezésre állással együtt).
  • GET /monitors/{id} - egyetlen monitor részletei.
  • POST /monitors - új monitort hoz létre. A kérés törzsében (JSON) küldd a name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword mezőket.
  • POST /monitors/bulk - tömeges importálás (legfeljebb 200 monitor egyetlen kérésben).
  • PATCH /monitors/{id} - meglévő monitor módosítása (csak azokat a mezőket küldd, amelyeket módosítani szeretnél).
  • POST /monitors/{id}/check - azonnali ellenőrzést indít az ütemezett intervallumon kívül; visszaadja a frissített monitort.
  • GET /monitors/{id}/uptime?days=30 - rendelkezésre állás %-ban az elmúlt N napra (1-365, alapértelmezetten 30); a karbantartási ablakok ki vannak zárva.
  • DELETE /monitors/{id} - törli a monitort (az ellenőrzések és incidensek előzményeivel együtt).

Ellenőrzések (előzmények)

  • GET /monitors/{id}/checks?limit=100 - egy monitor utolsó N ellenőrzése (állapot, válaszidő, HTTP status code, esetleges hiba, régió). A limit paraméter 1 és 500 között lehet, alapértelmezetten 50.

Incidensek

  • GET /incidents - incidensek listája. Választható szűrők: monitor_id, resolved (true/false), limit (1-500, alapértelmezetten 50).

Hibakódok

  • 401 - hiányzó vagy érvénytelen token.
  • 403 - a csomagod monitorkorlátja túllépve (létrehozáskor).
  • 404 - a monitor nem a tiéd, vagy nem létezik.
  • 429 - kérési korlát túllépve (percenként 60 tokenenként).

Gépileg olvasható dokumentáció

A teljes specifikáció OpenAPI szabványban a /api/openapi.json címen érhető el. Az interaktív dokumentációt, ahol a végpontokat közvetlenül kipróbálhatod (Swagger UI), a /api/docs címen találod. Mindkettő bejelentkezést vagy érvényes tokent igényel.

Hasznos volt ez az útmutató?