Skip to main content
PATCH
Update a monitor

Authorizations

Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Path Parameters

id
integer
required

The unique identifier of the monitor.

Body

application/json

A partial update. Only the keys present in the body are touched.

Unlike the as-code path — where the file is the whole truth, so an omitted threshold CLEARS the column — an omitted key here leaves the stored value alone. That asymmetry is the difference between declaring a monitor and editing one, and it is the pre-fork behaviour on both surfaces.

alert
AlertSpec · object | null

The thresholds. Names are the pre-fork ones; units are documented per field.

datadiff
DiffConfigSpec · object | null
description
string | null
enabled
boolean | null
name
string | null
owner
string | null
schedule
ScheduleSpec · object | null

One of three shapes, mirroring the pre-fork spec: cron, interval, or none.

slug
string | null
tags
string[] | null
type
string | null
Allowed value: "diff"

Response

Successful Response

The list row plus the definition, in exactly the shape create and update accept.

alert
AlertSpec · object
required

What makes a run alert.

created_at
string<date-time>
required

When the monitor was created.

enabled
boolean
required

Whether the schedule fires.

id
integer
required

Unique identifier for the monitor.

managed_in_code
boolean
required

True when the monitor's definition lives in a repo. Update and delete are refused for such a monitor — change its YAML instead.

modified_at
string<date-time>
required

When the monitor was last modified.

monitor_type
string
required

Type of the monitor.

Allowed value: "diff"
name
string | null
required

Name of the monitor.

schedule
ScheduleSpec · object
required

When the monitor runs.

datadiff
DiffConfigSpec · object | null

The diff the monitor runs. Null only for a monitor whose stored definition has gone missing, which cannot happen for one this API created.

description
string | null

Free-text description.

last_run
string<date-time> | null

When the monitor last started a run.

next_run
string<date-time> | null

When the schedule fires next.

owner
string | null

Email of the monitor owner.

slug
string | null

Stable identifier.

state
enum<string> | null

Outcome of the latest run, once it has one.

Available options:
ok,
alert,
error,
cancelled
tags
string[]

Tags on the monitor.