Skip to main content
PATCH
Edit a monitor

Headers

x-api-key
string
required

Path Parameters

monitor_id
string
required

Body

application/json

How often the monitor runs. Units: s, m, h, d = 24 h, w = 7 d. A bare number is seconds, single-unit only. There is no month unit because a month is not a duration. At least 1h and at most 366d.

At most one run per cadence period. Neither the time within the period nor the run's duration is guaranteed, and a missed period is not made up.

cadence
string
required
api_key
string | null
monitor_id
string
default:""
name
string | null
search_requests
object[]

Replaces the list wholesale when set. An empty list is read as "not set" and keeps the current requests. A request keeps its id and its health when every field of its body is unchanged.

status
enum<string>

A monitor's lifecycle state.

active is scheduled and running. paused runs nothing and keeps its records and its record of what it has already delivered. Only those two can be set through the API; disabled and deleted are set by Seltz.

Available options:
active,
paused,
disabled,
deleted
webhook
null | object

JSON null clears the webhook; an absent field keeps it. Set webhook.status to turn delivery on or off.

Response

Updated.

monitor
null | object

How often the monitor runs. Units: s, m, h, d = 24 h, w = 7 d. A bare number is seconds, single-unit only. There is no month unit because a month is not a duration. At least 1h and at most 366d.

At most one run per cadence period. Neither the time within the period nor the run's duration is guaranteed, and a missed period is not made up.