Skip to content

3.3Pause and resume

To pause a monitor is to stop it completely. No checks run and no new data is recorded. Pause a monitor when you retire or rebuild a service.

  1. Open the monitor from the dashboard.
  2. Select Pause at the top of the page. There is no confirmation step.
  3. The button changes to Resume. On the dashboard, the monitor's status shows Paused.
  4. To start checks again, select Resume.

If the action fails, the page shows Failed: followed by the reason.

While a monitor is paused:

  • No new checks run.
  • You cannot run a check now (3.6).
  • The monitor is never marked as having no recent data.
  • A heartbeat monitor still accepts pings. obsrvly expects no pings and reports no missed pings.
  • On your public status page, the monitor shows Not monitored (12.3).

Pause with the API#

Call UpdateMonitor. Send "activated": false to pause and "activated": true to resume:

Pause a monitor
json
{"id": "<monitor-id>", "activated": false}

The field is activated, not active. A wrong field name returns invalid_argument, for example unknown field "active" in UpdateMonitorRequest. To read the state, look at activated on the monitor.

Last updated