Skip to main content
POST
Pausing cancels a queued run with status skipped; a run already running finishes. Pausing an already paused monitor returns it unchanged, and a pause you request does not send a monitor.paused event.

Authorizations

Authorization
string
header
required

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

Path Parameters

monitor_id
string
required

Monitor identifier (mon_...)

Response

The paused monitor

Fields that do not apply are omitted, never null: webhook, pause_reason, current_run_id, next_run_at and last_run.

id
string
required

Opaque ID with the prefix mon_

Maximum string length: 64
object
enum<string>
required
Available options:
monitor
name
string
required
goal
string
required

"" when unset

targets
object[]
required

One thing a monitor watches. Today a monitor has exactly one search target, or 1 to 10 page targets with distinct URLs. New types may be added; skip targets with an unknown type.

schedule
object
required

When a monitor runs. New types may be added.

metadata
object
required

Up to 16 key value pairs; keys 1 to 64 characters, values up to 512 characters (Unicode code points, valid UTF-8). Echoed on every webhook.

status
enum<string>
required

active monitors run on their schedule; paused ones don't run until resumed. Whether a run is in flight is current_run_id, not the status. New statuses may be added; treat an unknown one as not running on its schedule.

Available options:
active,
paused
created_at
string<date-time>
required

RFC 3339 in UTC with whole seconds, for example 2026-11-12T09:00:41Z.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
updated_at
string<date-time>
required

RFC 3339 in UTC with whole seconds, for example 2026-11-12T09:00:41Z.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
webhook
object
pause_reason
enum<string>

Only while paused

Available options:
user,
insufficient_credits,
org_policy,
webhook_failing,
source_failing
current_run_id
string

The queued or running run

next_run_at
string<date-time>

Omitted while paused

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
last_run
object

The last finished run