Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Path Parameters

id
string
required

The monitor id returned by Create Monitor.

Body

application/json

Request body for the Update Monitor API.

status
enum<string>

paused stops scheduled runs; active resumes them. A monitor paused automatically for low balance stays paused after you top up until you send active.

Available options:
active,
paused
name
string

The monitor name.

Maximum string length: 256
condition
string | null

The notification condition. Send null or "" to remove it.

Maximum string length: 1000
topic
object

Search settings. topic monitors only. Send only the sub-fields to change; send null for a sub-field to reset it to its default.

page
object

Page settings. page monitors only. Send only the sub-fields to change.

schedule
object

How often the monitor runs. Use either interval or cron.

webhook
object | null

Where to push events. Send null to remove the webhook. Adding a webhook returns a new secret.

email
object | null

Email notifications. Send null to remove them.

metadata
object | null

Your own key-value pairs. Replaces the existing object instead of merging; send null or {} to clear it. Up to 8 pairs; keys up to 16 characters, string values up to 512 characters.

Response

Successful monitor update response

request_id
string
required

The unique identifier for this request.

code
integer

Business status code. 0 indicates success.

msg
string

A message describing the result.

data
object