Skip to content
Go to dashboard

3.7Edit and delete a monitor

Edit a monitor#

  1. Open the monitor and select Edit. The page title reads edit <monitor name>.
  2. Change what you need: the name, check interval, timeout, locations, alert channels (on failure — notify), the type's own settings, or the alert policy (chapter 9).
  3. Select save changes →. You return to the monitor's page. To leave without saving, select ← cancel.

If the save fails, the reason shows above the buttons at the bottom of the page.

  • You cannot change a monitor's type. The type tabs are locked. Hover over one to see A monitor's type can't be changed. To change the type, create a new monitor and delete the old one.
  • The name is required, can have at most 200 characters, and must not contain control characters.
  • The check interval follows the rules in 3.1.
  • A heartbeat monitor keeps its ping token when you edit it (chapter 5).

Edit with the API#

Call UpdateMonitor with the monitor's id. It changes only the fields you send and leaves the rest. For example, to rename a monitor and change its interval:

UpdateMonitor body
json
{"id": "<monitor-id>",
 "name": "Checkout API",
 "intervalSeconds": 300}
  • To change alert channels, send alertChannelIds with replaceAlertChannels: true. Without the flag, the list is ignored. To remove all channels, send [] with the flag.
  • To change regions, send locations with replaceLocations: true (3.2).
  • An unknown field returns invalid_argument and names the field.
  • Changing the type returns invalid input: monitor type cannot be changed.

When you save in the dashboard, settings you did not change are kept, with some exceptions. Saving removes settings that only the API can set and the form does not show: page checks and per-step timeouts on browser monitors (7.3), response-time assertions on DNS monitors (6), and a timeout sent through the API for DNS, TLS certificate and domain expiry monitors (3.1). Keep editing those monitors through the API.

Delete a monitor#

  1. Open the monitor and select Delete.
  2. A dialog asks delete <monitor name>?. Select delete monitor to confirm.
  3. To keep the monitor, select cancel, press Escape, or click outside the dialog.

When the delete succeeds, you return to the dashboard. If it fails, the dialog stays open and shows the error. You can try again or cancel. You delete monitors one at a time from each monitor's page.

Each delete is recorded in your team's audit log as monitor.deleted (chapter 14).

Through the API, call DeleteMonitor with {"id": "<monitor-id>"}. It returns {}. An unknown ID, or one from another team, returns not_found.

Last updated