Skip to Content
API & MCPPOSTUpdate a monitor

REST API

Update a monitor

Pause / resume a monitor, or change its name, collect settings, exclude or limits.

POST/v1/monitors/:monitor_id
MCP tool update_monitorscope monitors:writeNo record cost

Parameters

monitor_idstringrequired
namestringoptional
status"active" | "paused"optional
collectobjectoptional
prefilterobjectoptional
excludeobjectoptional
alias of prefilter (preferred)
limitsobjectoptional

What your agent reads

The tool description exactly as an MCP client receives it in tools/list — it doubles as the full behaviour of the endpoint.

Pause / resume a monitor, or change its name, collect settings, exclude (prefilter) or limits (a given key replaces the stored one whole; bumps version). Scheduled collections are kept: a paused monitor collects nothing until resumed; a profile monitor paused for no_subscription_7d needs a subscription before resuming or it pauses again at its next look. No record cost. Deleting is REST-only on purpose (DELETE /v1/monitors/:id): an agent must not be able to delete on a misread sentence.

Errors follow one format.

GETList monitorsDELDelete a monitor