Skip to main content
POST
Create a monitor

Headers

x-api-key
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
name
string
default:""

Unique per org among live monitors; a deleted monitor's name becomes available again. At most 512 bytes of UTF-8.

search_requests
object[]

At least one, at most 1000. Every request runs on every run. A request with an api_key set, a blank query, or a body identical to another in the list is rejected.

status
enum<string>

Set to paused to create the monitor without starting it. Only active and paused are accepted. Defaults to active.

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

Response

Created. webhook_secret is returned once and never again.

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.

webhook_secret
string
default:""

Returned once, at create, and never again. Issued whether or not the create supplied a webhook, so keep it.