API-Referenz

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

Authentifizierung : Authorization: Bearer cb_your_token

Endpoints

POST /api/v1/ingest/events

Ein Monitoring-Event senden (Start, Erfolg, Fehler).

Anfragekörper
FeldTypPflichtfeldBeschreibung
job_keystringEindeutiger Job-Bezeichner (Slug). Wird automatisch erstellt, falls nicht vorhanden.
eventstringEvent-Typ: started, succeeded, failed, completed
environmentstringUmgebung (prod, staging, dev). Standard: prod
duration_msintegerAusführungsdauer in Millisekunden
processed_countintegerAnzahl der verarbeiteten Elemente
error_countintegerAnzahl der aufgetretenen Fehler
messagestringFreier Text (Fehlerdetail, Zusammenfassung...)
event_idstringEindeutige ID zur Deduplizierung von Events (Idempotenz)
Event-Typen
Antwort
{
  "status": "ok",
  "run_id": "01924f8a-...",
  "job_id": "01924f8a-...",
  "event": "succeeded",
  "created": true
}

GET /api/v1/jobs

Alle Jobs im Tenant auflisten.

POST /api/v1/jobs

Einen neuen Job erstellen.

Anfragekörper
FeldTypBeschreibung
namestringJob-Name (Slug wird automatisch generiert)
typestringcron, batch, worker
environmentstringprod, staging, dev
cron_expressionstringStandard cron-Ausdruck (5 Felder)
expected_cadence_minutesintegerAlternative zu cron: Intervall in Minuten
grace_period_secondsintegerKarenzzeit in Sekunden, bevor der Job als verpasst gilt (Standard: 300)
severitystringlow, medium, high, critical

GET /api/health

Überprüfen, ob der Dienst betriebsbereit ist. Keine Authentifizierung erforderlich.

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

Eine Warnung bestätigen (setzt den Status auf 'bestätigt').

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

Eine Warnung stummschalten. Parameter: Minuten (Dauer der Stummschaltung).

Rate Limiting

Anfragen sind je nach Plan begrenzt: Free 30/Min, Pro 120/Min, Business 300/Min. Bei Überschreitung gibt die API einen 429-Statuscode zurück.