Home / Docs

Documentation

How DiffMon works across monitoring, alerts, security, and API integration.

API overview

Use the public API to manage monitors, snapshots, and webhooks programmatically.

API overview

Everything in the UI can also be automated through the public API.

Authentication

  • Bearer tokens created in the dashboard.
  • Send Authorization: Bearer <token> on every request.
  • Rate limits apply per org and per endpoint.

Common endpoints

  • POST /api/monitors to create a monitor.
  • GET /api/monitors/{id}/diffs to fetch change history.
  • POST /api/webhooks/worker/run to trigger test deliveries.
Shell
curl -H "Authorization: Bearer $TOKEN" \
  https://api.diffmon.example.com/api/monitors

Errors

Errors include request IDs and machine-readable codes so you can retry or surface meaningful messages upstream.

Browser Render via API

For JS-heavy website monitors, set browserOptions when creating or updating a URL monitor.

  • Request field: browserOptions
  • Stored/returned monitor field: browserOptionsJson

See Browser Render docs for valid option shapes, examples, and error codes.

Policy Rules via API

Policy rules are configured through monitor settings:

  • GET /api/monitors/{id}/settings to read policyRulesJson
  • PATCH /api/monitors/{id}/settings with policyRules to replace the full rule set

Use rules: [] to clear rules. Omit policyRules to leave stored rules unchanged. See Policy rules for rule schema and behavior.