Update Monitor
update_monitorDestructive
Replace an existing Monitor's exposed configuration: name, Script, frequency, engine ids, failure and recovery thresholds, tags, and the acceptable-metric thresholds. An omitted threshold is cleared and omitted tags are removed, so read the current configuration with get_monitor first and send everything that should remain. 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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The new monitor name. | |
| tags | No | Tag names to organize the Monitor. Prefer the names other Monitors already carry, as list_monitors reports them — a name that doesn't exist yet becomes a new tag, so don't invent tags the user didn't ask for. Omit for no tags. | |
| scriptId | Yes | The id of the Script in this project the Monitor plays each Cycle. | |
| engineIds | Yes | 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 | Yes | 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 is not checked; omit the whole object to check none. | |
| 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). |