Update Monitor
update_monitorUpdate an existing Monitor's exposed configuration: name, Script, frequency, engine ids, failure and recovery thresholds, tags, and the acceptable-metric thresholds. Each is optional: a field left out keeps its stored value, and a list sent replaces the whole list, never merging into it. The thresholds object works the same way: left out, the limits stay as they are; sent, it replaces all of them, so a limit left out of it is cleared and an empty object clears every limit. Read the current configuration with get_monitor before changing the thresholds. Everything outside those fields is untouched: an update never changes whether the Monitor is enabled, and never touches its notification policies or maintenance windows, so a config edit cannot stop a running Monitor, start a stopped one, or unhook the user's alerting. To start a disabled Monitor, call enable_monitor at the "Read+Write+Execute" access level; below that level the tool is absent, and the user enables it in the Dashboard at the returned link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The new monitor name. | |
| tags | No | Tag names; a name the team doesn't have yet becomes a new tag. Omit to keep the current tags; send [] to clear them. | |
| scriptId | No | The id of the Script in this project the Monitor plays each Cycle. | |
| engineIds | No | The ids of the monitoring locations the Cycles run from, as list_monitoring_locations reports them; at least one is required. Monitoring locations are their own set, not the load test regions list_engines offers, and an unknown id is refused with an error naming the valid ones. | |
| frequency | No | How often a Cycle runs, in milliseconds: 60000 (one minute) to 86400000 (one day). | |
| monitorId | Yes | ||
| projectId | Yes | ||
| thresholds | No | The acceptable-metric limits a Cycle is judged against, each optional within the object: responseTimeAverageMin/Max, responseTimeTotalMin/Max, cycleDurationMin/Max, timeToFirstByteMax, firstContentfulPaintMax, largestContentfulPaintMax, and totalBlockingTimeMax in milliseconds; cumulativeLayoutShiftMax as the unitless Web Vitals score; performanceScoreMin as the 0-100 floor. A limit left out of the object is not checked. | |
| failureThreshold | No | Consecutive failed Cycles before an Incident opens (1 to 128; default 1). | |
| recoveryThreshold | No | Consecutive passing Cycles before an open Incident closes (1 to 128; default 1). |