Domů / Docs

Dokumentace

Jak DiffMon funguje v oblasti monitoringu, alertů, bezpečnosti a API integrace.

Přehled API

Používejte veřejné API ke správě monitorů, snapshotů a webhooků programově.

Přehled API

Vše, co zvládnete v UI, lze automatizovat také přes veřejné API.

Autentizace

  • Bearer tokeny vytvořené v dashboardu.
  • U každého requestu posílejte Authorization: Bearer <token>.
  • Rate limity platí per org i per endpoint.

Běžné endpointy

  • POST /api/monitors pro vytvoření monitoru.
  • GET /api/monitors/{id}/diffs pro načtení historie změn.
  • POST /api/webhooks/worker/run pro spuštění testovací delivery.
Shell
curl -H "Authorization: Bearer $TOKEN" \
  https://api.diffmon.example.com/api/monitors

Chyby

Chyby obsahují request ID a machine-readable kódy, takže je můžete opakovat nebo smysluplně zobrazit upstreamu.

Browser Render přes API

U monitorů URL náročných na JavaScript nastavte při vytváření nebo update browserOptions.

  • Pole requestu: browserOptions
  • Ukládané a vracené pole monitoru: browserOptionsJson

Platné tvary options, příklady a error codes najdete v docs Browser Render.

Policy Rules přes API

Policy Rules se konfigurují přes nastavení monitoru:

  • GET /api/monitors/{id}/settings načte policyRulesJson
  • PATCH /api/monitors/{id}/settings s policyRules nahradí celý rule set

Použijte rules: [] pro vyčištění pravidel. Vynechte policyRules, pokud chcete uložená pravidla nechat beze změny. Schéma pravidel a chování popisují Policy rules.