Update a Monitor
Updates a monitor. If target or change_detection changes, the monitor creates a new baseline. Unsupported target/change detection combinations are rejected.
target or change_detection resets the monitor’s baseline: the next run re-captures it instead of reporting a spurious change. Unsupported target/change detection combinations are rejected — supported pairs are page + exact, page + semantic, sitemap + exact, and extract + semantic.Adding target.instructions to an exact page monitor (without also passing change_detection) flips it to semantic automatically, matching the create-time default. Passing change_detection: { type: "exact" } alongside instructions, or clearing instructions on a semantic page monitor, is rejected.Authorizations
Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.
Path Parameters
"mon_123"
Body
Shared monitor update fields. target and change_detection can be updated, but the final combination must be supported.
1 - 200"Acme pricing monitor"
User-defined tags for grouping and filtering monitors and their changes. Duplicates are removed.
201 - 50active, paused Discriminated union describing what the monitor watches.
- Page target
- Sitemap target
- Extract target
Discriminated union describing how changes are detected.
- Exact
- Semantic
Discriminated union describing how the monitor is scheduled. Only interval is supported today; cron and exact_time are reserved for future use.
Set to null to remove the webhook.
Response
Updated monitor
A web monitor. mode is the constant web; behavior is described by target (page/sitemap/extract) and change_detection (exact/semantic).
Top-level monitor category. Always web today; the concrete behavior is described by target and change_detection.
web "mon_123"
"Acme pricing monitor"
Discriminated union describing what the monitor watches.
- Page target
- Sitemap target
- Extract target
Discriminated union describing how changes are detected.
- Exact
- Semantic
Discriminated union describing how the monitor is scheduled. Only interval is supported today; cron and exact_time are reserved for future use.
Monitor lifecycle status. failed means the most recent run failed (see the monitor's last_error); failed monitors keep running on schedule and flip back to active on the next successful run. Monitors are auto-paused after repeated consecutive failures or insufficient-credit skips; resume by PATCHing status to active.
active, paused, failed When the next scheduled run is due.
Error from the most recent failed run; null when the last run succeeded.
Present while webhook deliveries are failing consecutively; null when deliveries are healthy or no webhook is configured. Cleared on the next successful delivery and when the webhook URL changes.
User-defined tags for grouping and filtering monitors and their changes. Duplicates are removed.
201 - 50Current baseline: the last observed value the monitor compares new snapshots against. Its shape follows target.type (page/sitemap/extract). Only populated on GET /monitors/{monitor_id}; null until the first baseline run completes (and after a target or change_detection update, which resets the baseline).
- Page baseline
- Sitemap baseline
- Extract baseline