Riferimento API

Base URL : https://cronbeacon.com/api/v1

Autenticazione : Authorization: Bearer cb_your_token

Endpoints

POST /api/v1/ingest/events

Inviare un evento di monitoring (avvio, successo, errore).

Corpo della richiesta
CampoTipoObbligatorioDescrizione
job_keystringIdentificatore univoco del job (slug). Creato automaticamente se non esiste.
eventstringTipo di evento: started, succeeded, failed, completed
environmentstringAmbiente (prod, staging, dev). Default: prod
duration_msintegerDurata di esecuzione in millisecondi
processed_countintegerNumero di elementi elaborati
error_countintegerNumero di errori riscontrati
messagestringTesto libero (dettaglio errore, riepilogo...)
event_idstringID univoco per deduplicare gli eventi (idempotenza)
Tipi di eventi
Risposta
{
  "status": "ok",
  "run_id": "01924f8a-...",
  "job_id": "01924f8a-...",
  "event": "succeeded",
  "created": true
}

GET /api/v1/jobs

Elenca tutti i job nel tenant.

POST /api/v1/jobs

Crea un nuovo job.

Corpo della richiesta
CampoTipoDescrizione
namestringNome del job (lo slug viene generato automaticamente)
typestringcron, batch, worker
environmentstringprod, staging, dev
cron_expressionstringEspressione cron standard (5 campi)
expected_cadence_minutesintegerAlternativa a cron: intervallo in minuti
grace_period_secondsintegerPeriodo di tolleranza in secondi prima di dichiarare il job mancato (predefinito: 300)
severitystringlow, medium, high, critical

GET /api/health

Verifica che il servizio sia operativo. Nessuna autenticazione richiesta.

POST /api/v1/alerts/{id}/ack

Conferma un avviso (imposta lo stato su 'acked').

POST /api/v1/alerts/{id}/mute

Silenzia un avviso. Parametro: minuti (durata del silenziamento).

Rate Limiting

Le richieste sono limitate dal piano: Free 30/min, Pro 120/min, Business 300/min. In caso di superamento, l’API restituisce un codice di stato 429.