Beta — the versioned request may change; breaking changes are
coordinated with affected customers. The default request is stable.
Updates a monitor with a JSON merge patch
(RFC 7396) over the
writable fields of Monitor-Resource, and returns the updated monitor.
The Observe-Api-Version header picks one of two behaviors.
Default (no header). The long-standing update, which does not
change: it takes name, disabled, description, ruleKind, and
definition and actionRules in their default GET shape, replaces
definition and actionRules whole, ignores any other key, and
answers 204. The schema on this page describes the versioned shape,
not this one.
Versioned. Observe-Api-Version: 2026-10-06 or later takes a
Monitor-UpdateRequest and answers 200 with the Monitor-Resource.
It is rolling out account by account; until it reaches yours, the
header returns 403. An earlier or unparseable date takes the default
behavior.
The patch is applied to the monitor as Monitor-CreateRequest would
write it, and the result must be a valid Monitor-CreateRequest:
- An omitted field keeps its value.
- An object merges member by member, so
{"scheduling": {"cron": {"timezone": "UTC"}}}changes the timezone
and keeps the cron expression. - An array replaces the whole list, so
{"rules": [...]}replaces the
rules and leavesinputQueryalone. nullresets a field to its default, and cannot be sent for a field
Monitor-CreateRequestrequires.
Changing ruleKind keeps the other fields, so null the ones the new
kind rejects in the same patch. Switching between the branches of
scheduling or between baseline algorithms works the same way:
{"scheduling": {"cron": null, "transform": {...}}}.
Actions are maps, so they merge by key like any object: sharedActions
by action id and inlineActions by name. One patch can add, change or
remove any of them without sending the others:
{"inlineActions": {"oncall-pager": {"levels": ["Critical"]}}}
changes one rule's levels, and {"sharedActions": {"41000300": null}}
unbinds one action. The maps themselves cannot be null: remove the
actions one entry at a time. A changed inline action is edited in place, keeping
its id, its pending reminders and the stored value of a redacted header
sent back masked. A shared action is edited through its own endpoint,
not here.
A monitor that still runs on a retired interval schedule keeps it until
a patch sets scheduling or changes ruleKind to Anomaly; an
interval cannot be set, so one other than GET reports is a 400. A monitor whose
stage reads a query parameter keeps that input until a patch sets
inputQuery, which is a 409.
A monitor read by GET can be sent back whole, edited or not:
- A field sent back as
GETread it is not a change, so a monitor
keeps what this API cannot write, such as a retired interval schedule
or a query parameter input, until that field is edited.nullstill
resets a field to its default. - It is still a merge patch, so an entry left out of a map, such as
inlineActions,sharedActions,objectTagsorcustomVariables,
is kept. Set the entry tonullto remove it. - Read-only fields are ignored, except that
idmust name this monitor
andmanagedBymust be unchanged, or it is a400.
The last writer wins: a patch is not conditional on the monitor being
unchanged since it was read.
A patch that changes nothing, such as a GET body sent back as read,
is not saved: it answers 200 with the monitor as it stands. One that
changes only disabled enables or disables the monitor as the web
app's toggle does, leaving monitorVersion and the AI identity as
they are. Any other update makes the caller the identity AI
investigations of the monitor run as, as an update in the web app
does.
A monitor managed by an app is a 403 unless the caller is that app. A
name already in use is a 409, as is a monitor changed by someone else
while the patch was applied (read it again and retry), and a patch that
fails only because the stored monitor cannot be written back as it
stands. A Composite monitor is a 400: update it with
PATCH /v1/composite-monitors/{id}.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
204The monitor was updated (default, unversioned request only)