Monitors

Update, pause, or resume a monitor

Only the fields you send are changed. Send status to pause or resume: "paused" always succeeds, "active" is re-checked against the plan ceiling and the browser-execution gate, because resuming is the transition that can put an account over its limit. The quota check, the status change and the field updates happen in one transaction, so a patch either fully applies or not at all.

patch/monitors/{monitorId}

Request

Base URL: https://api.domscout.io
URL: https://api.domscout.io/monitors/{monitorId}
Auth: API key in header x-api-key

Path parameters

monitorIdstring uuid required

Request body

namestring

targetUrlstring uri

status'active' | 'paused'

intervalMinutesinteger

At least the plan minimum, at most 43200 (30 days).

captureParamsobject

notifyWebhookUrlstring uri nullable

HTTPS only.

checkMarkdownboolean

checkLinksboolean

checkTitleboolean

checkStatusCodeboolean

checkDomboolean

domIgnoreSelectorsstring[]

domIgnoreAttributesstring[]

domIgnoreTextPatternsstring[]

domPositionTolerancePxnumber

Response

Updated.

Changes

No recorded changes to this operation across all 1 revision of this API.