Update a monitor

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 leaves inputQuery alone.
  • null resets a field to its default, and cannot be sent for a field
    Monitor-CreateRequest requires.

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 GET read 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. null still
    resets a field to its default.
  • It is still a merge patch, so an entry left out of a map, such as
    inlineActions, sharedActions, objectTags or customVariables,
    is kept. Set the entry to null to remove it.
  • Read-only fields are ignored, except that id must name this monitor
    and managedBy must be unchanged, or it is a 400.

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}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the monitor. A string, as every response body renders it.

Body Params

A JSON merge patch over the writable fields of a monitor, which are the fields of Monitor-CreateRequest. Objects merge, arrays replace, and null resets a field to its default. The read-only fields of Monitor-Resource are accepted, so a GET body can be sent back, although additionalProperties: false below does not list them. Any other field not listed here, at any depth, is a 400, as is a body nested more than 32 levels deep. A body larger than 4 MiB is a 413. The nested objects are the -Patch schemas: they require nothing, since the result is checked once merged.

string
length ≥ 1

Name of the monitor, unique within its workspace.

string | null

Monitor description. null clears it.

boolean | null

Turn the monitor off or on. null turns it on.

string
enum

The evaluation rule kind of the monitor. Composite is the one kind that inspects no query: it alerts on a boolean condition over whether other monitors are currently alerting, correlated per group.

Allowed:
MonitorAiTriagingMode | null

AI auto-investigation mode. null resets it to None.

int64 | null
≥ 1

AI SRE investigations allowed per window. Set together with aiSreInvestigationWindowSeconds; null on both returns to the account default.

int64 | null
3600 to 86400

The window, in seconds: a whole number of hours from 1 to 24. Set together with aiSreMaxInvestigationsPerMonitor.

aiSreTriggerLevels
array of objects | null

Replaces the severities that start an AI SRE investigation, never None, which is not a severity an alert has. null triggers on every severity. An empty list is a 400: to turn investigations off, set aiTriagingMode to None.

aiSreTriggerLevels
Allowed:
double
≥ 0

Window of data each evaluation considers, in seconds. Above 0, except for a Promote monitor without a cron schedule, which promotes rows as they arrive and takes 0.

double | null
≥ 0

Delay before judging a window, in seconds. null takes the server default.

int64 | null
≥ 1

Alerts per hour after which the monitor disables itself. null takes the server default.

MonitorSchedulingPatch | null

The schedule to run on. null lets the server choose.

inputQuery
object

A merge patch over Monitor-MultiStageQueryInput. stages replaces the whole list.

string | null

Column of the query output the monitor watches.

MonitorValueAggregation | null

How valueColumn is reduced over each window.

MonitorBaselinePatch | null

The baseline an anomaly monitor compares against.

rules
array of objects
length ≥ 1

Replaces the rules.

rules
groupBy
array of objects | null

Replaces the dimensions. null removes them.

groupBy
serviceBindings
array of objects | null

Replaces the service binding. null removes it.

serviceBindings
sharedActions
object

Merged by action id: a value merges into that action's rule, null unbinds the action, and an id not yet bound binds that shared action.

inlineActions
object

Merged by name: a value merges into that action and its rule, which keeps its id, its pending reminders and the stored value of a redacted header sent back masked; null deletes the action; a new name creates one.

customVariables
object | null

Template variables, merged by key. null removes them.

objectTags
object | null

Tags, as a map of tag key to a list of values, merged by key: a key set to a list replaces that key's values, a key set to null removes it, and null removes them all. A result missing a tag the workspace requires on monitors is a 400.

Headers
string
^\d{4}-\d{2}-\d{2}$

Picks the request and response shape by release date (YYYY-MM-DD). 2026-10-06 or later takes Monitor-UpdateRequest and returns Monitor-Resource, if enabled for your account (otherwise 403). No header, or an earlier or unparseable date, takes the default behavior described above.

string

Reserved for future optimistic concurrency (ETag); accepted and ignored (v1 is last-writer-wins).

Responses

204

The monitor was updated (default, unversioned request only)

Language
Credentials
Bearer
Authorization: Bearer <customerid> <apitoken>
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json