Pause or resume a monitor
set_monitor_pausedUse this when the user wants to stop or restart checks of a site or one of its checks, for example during planned work. Returns the new state and what it means: pausing a site stops its checks, content checks and dependencies, holds its DNS watch alerts, and resolves its open automatic incidents, but its cron jobs keep alerting until each is paused; pausing frees no room on the plan; resuming must fit the plan's active monitors. Not for scheduling maintenance windows or deleting a monitor: those are in the dashboard.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | The site, by id, name or part of its URL. | |
| check | No | One of the site's content checks, dependencies or cron jobs, by id or name; leave out for the whole site. | |
| paused | Yes | True to pause, false to resume. |