Create Monitor
create_monitorCreate a Monitor in a project — always disabled, and nothing on this surface can enable one. An enabled Monitor consumes fuel on its schedule, unattended, so enabling is the user's act in the Dashboard, at the link the returned summary carries. Read the 'monitoring' topic before choosing a frequency or thresholds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The 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). | |
| 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). |