Start / Docs

Dokumentation

Wie DiffMon bei Monitoring, Alerts, Sicherheit und API-Integration funktioniert.

API-Überblick

Nutzen Sie die öffentliche API, um Monitore, Snapshots und Webhooks programmgesteuert zu verwalten.

API-Überblick

Alles, was im UI möglich ist, lässt sich auch über die öffentliche API automatisieren.

Authentifizierung

  • Bearer-Tokens, die im Dashboard erstellt werden.
  • Senden Sie bei jeder Anfrage Authorization: Bearer <token>.
  • Rate Limits gelten pro Organisation und pro Endpoint.

Häufige Endpunkte

  • POST /api/monitors zum Erstellen eines Monitors.
  • GET /api/monitors/{id}/diffs zum Abrufen der Änderungshistorie.
  • POST /api/webhooks/worker/run zum Auslösen von Test-Deliveries.
Shell
curl -H "Authorization: Bearer $TOKEN" \
  https://api.diffmon.example.com/api/monitors

Fehler

Fehler enthalten Request-IDs und machine-readable Codes, sodass Sie gezielt retryn oder sinnvolle Meldungen upstream ausgeben können.

Browser Render per API

Für JavaScript-lastige URL-Monitore setzen Sie beim Erstellen oder Aktualisieren browserOptions.

  • Request-Feld: browserOptions
  • Persistiertes und zurückgegebenes Monitor-Feld: browserOptionsJson

Gültige Options-Formen, Beispiele und Fehlercodes finden Sie in den Browser Render Docs.

Policy Rules per API

Policy Rules werden über die Monitor-Einstellungen konfiguriert:

  • GET /api/monitors/{id}/settings liest policyRulesJson
  • PATCH /api/monitors/{id}/settings ersetzt mit policyRules den gesamten Rule-Set

Verwenden Sie rules: [], um Regeln zu leeren. Lassen Sie policyRules weg, wenn gespeicherte Regeln unverändert bleiben sollen. Das Regelschema und Verhalten beschreibt Policy rules.