Pomoc a návodyAPI a integrácie › Prehľad API endpointov

Prehľad API endpointov

5 min čítania · API a integrácie

Prehľad všetkých dostupných API endpointov (jednotlivých URL adries REST API, na ktoré sa volá). Základná URL: https://epulz.io/api/v1

Autorizácia: posielajte hlavičku Authorization: Bearer epulzio_.... Limit požiadaviek (rate limit) je 60 požiadaviek za minútu na token. Token vygenerujete v Nastaveniach -> API tokeny.

Status / kontrola tokenu

  • GET /status - overí token, vráti e-mail, plán, počet monitorov a počet otvorených incidentov.

Monitory

  • GET /monitors - zoznam všetkých vašich monitorov (vrátane dostupnosti za posledných 24 h).
  • GET /monitors/{id} - detail jedného monitora.
  • POST /monitors - vytvorí nový monitor. V tele požiadavky (JSON) pošlite polia name, type, target, interval_minutes, expected_status, expected_keyword.
  • POST /monitors/bulk - hromadný import (najviac 200 monitorov v jednej požiadavke).
  • PATCH /monitors/{id} - úprava existujúceho monitora (pošlite iba polia, ktoré chcete zmeniť).
  • DELETE /monitors/{id} - zmaže monitor (spolu s históriou kontrol a incidentov).

Kontroly (história)

  • GET /monitors/{id}/checks?limit=100 - posledných N kontrol monitora (stav, čas odozvy, HTTP status code, prípadná chyba, región). Parameter limit môže byť 1 až 500, predvolene 50.

Incidenty

  • GET /incidents - zoznam incidentov. Voliteľné filtre: monitor_id, resolved (true/false), limit (1-500, predvolene 50).

Chybové kódy

  • 401 - chýbajúci alebo neplatný token.
  • 403 - prekročený limit monitorov vášho plánu (pri vytváraní).
  • 404 - monitor nepatrí vám alebo neexistuje.
  • 429 - prekročený limit požiadaviek (60 za minútu na token).

Strojovo čitateľná dokumentácia

Kompletná špecifikácia v štandarde OpenAPI je dostupná na /api/openapi.json. Interaktívnu dokumentáciu, kde si môžete endpointy priamo vyskúšať (Swagger UI), nájdete na /api/docs. Obe vyžadujú prihlásenie alebo platný token.