Monitors

Create a monitor

A monitor is a standing instruction to capture a URL unattended on a schedule and report what changed. It carries the same API-key authentication and the same browser-execution gate as a capture, because it is a capture with a timer.

Plan ceilings: Hobby 0 monitors (403 PLAN_FEATURE_UNAVAILABLE), Pro 10 at a minimum interval of 60 minutes, Business 100 at 15 minutes, Enterprise 500 at 5 minutes. GET /credits reports availability under capabilities.routes["/monitors"].

Management calls are not billed. Each RUN reserves capture quota exactly as a scheduled check does, priced from the monitor's own captureParams.

If notifyWebhookUrl is set, the creation response carries notifyWebhookSecret. No API read returns it, so store it on receipt. Unlike an API key it is not unrecoverable: the account owner can reveal it in the dashboard, and POST /monitors/{monitorId}/rotate-secret replaces it, disclosing the replacement in that response.

post/monitors

Request

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

Request body

namestring required
targetUrlstring uri required
intervalMinutesinteger

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

captureParamsobject
notifyWebhookUrlstring uri nullable

HTTPS only. Change notifications are signed with the secret returned at creation.

checkMarkdownboolean
checkLinksboolean
checkTitleboolean
checkStatusCodeboolean
checkDomboolean
domIgnoreSelectorsstring[]
domIgnoreAttributesstring[]
domIgnoreTextPatternsstring[]
domPositionTolerancePxinteger

Response

Created.

notifyWebhookSecretstring

Present only when notifyWebhookUrl was set. No API read returns it; the account owner can reveal it in the dashboard.

notifyWebhookSecretNotestring

Present with notifyWebhookSecret and explains its one-time disclosure.

Changes

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