Aiuto e guideAPI e integrazioni › Panoramica endpoint API

Panoramica endpoint API

5 min di lettura · API e integrazioni

Panoramica di tutti gli endpoint API disponibili (i singoli URL dell'API REST che vengono richiamati). URL di base: https://epulz.io/api/v1

Autorizzazione: invia l'intestazione Authorization: Bearer epulzio_.... Il limite di richieste (rate limit) è di 60 richieste al minuto per token. Il token si genera in Impostazioni -> Token API.

Gestione dei token API per l'accesso all'API REST
Il token per le chiamate API si crea e si gestisce nella sezione Token API.

Stato / verifica del token

  • GET /status - verifica il token, restituisce l'e-mail, il piano, il numero di monitor e il numero di incidenti aperti.

Monitor

  • GET /monitors - elenco di tutti i tuoi monitor (compresa la disponibilità delle ultime 24 h).
  • GET /monitors/{id} - dettaglio di un singolo monitor.
  • POST /monitors - crea un nuovo monitor. Nel corpo della richiesta (JSON) invia i campi name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
  • POST /monitors/bulk - importazione in blocco (al massimo 200 monitor in una singola richiesta).
  • PATCH /monitors/{id} - modifica di un monitor esistente (invia solo i campi che vuoi modificare).
  • POST /monitors/{id}/check - avvia un controllo immediato al di fuori dell'intervallo pianificato; restituisce il monitor aggiornato.
  • GET /monitors/{id}/uptime?days=30 - disponibilità in % negli ultimi N giorni (1-365, predefinito 30); le finestre di manutenzione sono escluse.
  • DELETE /monitors/{id} - elimina il monitor (insieme alla cronologia dei controlli e degli incidenti).

Controlli (cronologia)

  • GET /monitors/{id}/checks?limit=100 - gli ultimi N controlli di un monitor (stato, tempo di risposta, HTTP status code, eventuale errore, regione). Il parametro limit può essere da 1 a 500, predefinito 50.

Incidenti

  • GET /incidents - elenco degli incidenti. Filtri facoltativi: monitor_id, resolved (true/false), limit (1-500, predefinito 50).

Codici di errore

  • 401 - token mancante o non valido.
  • 403 - limite di monitor del tuo piano superato (in fase di creazione).
  • 404 - il monitor non ti appartiene o non esiste.
  • 429 - limite di richieste superato (60 al minuto per token).

Documentazione leggibile dalla macchina

La specifica completa nello standard OpenAPI è disponibile su /api/openapi.json. La documentazione interattiva, dove puoi provare direttamente gli endpoint (Swagger UI), si trova su /api/docs. Entrambe richiedono l'accesso o un token valido.

Questa guida è stata utile?