monitor_update
Idempotent
Change a monitor. Only the arguments sent change; null or "" clears an optional setting. Changing check_type resets the settings the new type does not use. A new url that would send the stored request headers, body or UDP payload to another host is refused (secret_host_change_unconfirmed) unless confirm_secret_host_change is true. While the owner's stored request headers stay, only the owner may change url, request_method or request_body (secret_scope_change_forbidden); anyone else sends request_headers anew or clears them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Target. http/ssl/api: a URL (https:// is assumed); other types: a host. Private, reserved and unresolvable hosts are refused. | |
| name | No | Display name. null or "" clears it. | |
| note | No | Private note; "" empties it. | |
| port | No | port monitors: TCP port (default 80). udp monitors: UDP port, required. | |
| tags | No | Up to 10 tags. | |
| keyword | No | http only: text the body must (or must not) contain. null or "" clears it. Refused for api monitors, which do not check it: use assert_body there. | |
| cache_bust | No | http/api: add enterno_nocache=<random> to the request URL on every check, so a CDN or cache cannot answer with a stored copy (default false). The stored url stays as it is. Refused for a url whose query carries a known signature or CDN token parameter. Does not guarantee the origin answers: a cache that ignores the query string still can. | |
| check_type | No | Default http on create. Switching type resets the settings the new type does not use. | |
| group_name | No | Group of the monitor, as «Set group» in the cabinet: up to 50 letters, digits, spaces, "_" and "-"; "" takes it out of its group. Business plan and above (plan_required otherwise). | |
| monitor_id | Yes | Monitor id from monitor_list | |
| udp_expect | No | udp monitors: bytes a reply must contain to count; null or "" accepts any reply. | |
| udp_format | No | udp monitors: how udp_payload and udp_expect are written (default text; hex for binary protocols). | |
| assert_body | No | api monitors: text the response must contain. null or "" clears it. | |
| udp_packets | No | udp monitors: packets sent per check (default 3). | |
| udp_payload | No | udp monitors, required: the datagram sent on every check, 1-512 bytes, as text or hex (udp_format). Never returned by these tools. | |
| keyword_mode | No | ||
| notify_email | No | ||
| request_body | No | api monitors: request body. Never returned by these tools. null or "" clears it. | |
| assert_status | No | api monitors: expected status, overriding expected_code. null clears it. | |
| check_regions | No | Region codes; those the plan does not include fall back to ru-msk. | |
| expected_code | No | Expected HTTP status (default 200); 0 = any 2xx/3xx. 1-99 are refused. | |
| request_method | No | api monitors only. | |
| udp_timeout_ms | No | udp monitors: wait for each reply, ms (default 1000). | |
| dns_watch_types | No | dns_change monitors: record types to watch (default A, MX, NS). | |
| notify_telegram | No | ||
| request_headers | No | http/api: headers sent with every check. Write-only: never returned. {} or null clears them. | |
| request_timeout | No | http/api: seconds for the whole request, redirects included (default 15). | |
| assert_body_case | No | api monitors: whether assert_body must match letter case (default false: «OK» also matches «ok»). Ignored by other types. | |
| follow_redirects | No | http/api: whether a check follows redirects (at most 5, each hop checked before it connects). null: the type's rule — an http monitor follows unless it has request_headers, an api monitor does not. A monitor with request_headers or an api request_body follows only to the same host and port (or http to https): a redirect elsewhere is the answer. | |
| interval_minutes | No | Check interval. Create raises it to the plan floor; update refuses a value below it. | |
| udp_max_loss_pct | No | udp monitors: share of packets that may go without a valid reply while the monitor stays up (default 50). At least one valid reply is always required. | |
| show_on_status_page | No | ||
| heartbeat_grace_minutes | No | heartbeat monitors only: minutes a ping may be late before the monitor is down (default 0). Refused for other types. | |
| confirm_secret_host_change | No | Set true only when the owner agrees that a new url may send this monitor's stored request headers, body or UDP payload to another host (or to the same host over plain http). Without it such a change is refused with secret_host_change_unconfirmed and nothing is written. Only the monitor's owner (a team monitor: the team's owner) may confirm; anyone else gets secret_host_change_forbidden. Each confirmation is recorded in the audit log and the owner gets an email about it. |