Skip to main content
PATCH

Price

Free. See Pricing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The monitor id.

Body

application/json
origin
string

Set by client libraries. Ignored.

Maximum string length: 200
integration
string

Set by client libraries. Ignored.

Maximum string length: 200
name
string

A name for the monitor.

Required string length: 1 - 256
schedule
object
targets
object[]
Required array length: 1 - 50 elements
retentionDays
integer

How many days checks, diffs and snapshots are kept. 30 by default.

Required range: 1 <= x <= 365
webhook
object | null
notification
object | null
goal
string | null

What matters to you, in plain words. With a goal, every changed page is judged against it ($1 per 1,000 pages more for each changed page) and the page says whether the change is meaningful. judgeEnabled false turns the judge off.

Maximum string length: 2000
judgeEnabled
boolean
status
enum<string>

paused stops the checks; active starts them again.

Available options:
active,
paused

Response

The monitor as it is now.

success
any
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required
id
string
data
object
next
string | null