Domains

Set the content check

Watch a page on this website — or the part of it a CSS selector picks — for change. Every 5 minutes the page's visible text is compared with the previous probe's; mode decides whether any change counts, or only a change, drop or rise in the first number in the selection. A change alerts on the probe that sees it and becomes the new baseline; an unreadable page, an unmatched selector or a missing number is confirmed by a second probe before any rule fires. Replaces any previous setting and probes immediately, which records the baseline. If the organization has no alert rule for content checks yet, an email rule is created so changes reach the key's creator.

put/v1/domains/{id}/content

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/domains/{id}/content
  • Auth: HTTP bearer

Path parameters

idstring required
Example:9b1d...

Opaque identifier.

Request body

pathstring

The page to request on the website's hostname. Defaults to /.

selectorstring

CSS selector for the part of the page to watch: type, class, id and attribute selectors, :nth-child, :not, and the descendant and child combinators. Empty watches the whole page's text.

mode'text' | 'number' | 'decrease' | 'increase'

What the content check compares between probes. text: the selected text, so any change alerts. number: the first number in the selection, so a change to it alerts. decrease: only when that number goes down (a price drop). increase: only when it goes up.

enabledboolean

Pause the check without forgetting its settings.

Example request

{
  "path": "/checkout",
  "selector": "#price"
}

Response

The content monitor after the first probe.

idstring required

Opaque identifier.

organizationIdstring required

Opaque identifier.

domainIdstring required

Opaque identifier.

subject'http' | 'certificate' | 'dns' | 'registration' | 'keyword' | 'content' | 'port' required

Which check a monitor, rule or history row is about.

enabledboolean required

Whether the scheduler runs it. The keyword, content and port checks are disabled until they have a config.

intervalMsnumber required
nextChecknumber required

Unix ms.

lastCheckednumber required
status'checking' | 'ok' | 'warn' | 'crit' | 'unknown' required
summarystring required
detailunknown required
lastErrorstring nullable required
consecutiveFailuresnumber required
failingSincenumber nullable required

Example response

{
  "id": "9b1d...",
  "organizationId": "9b1d...",
  "domainId": "9b1d..."
}

Changes

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