Domains

Set the keyword check

Name the text a page on this website must contain (present) or must not contain (absent), and the check runs every 5 minutes against the raw HTML the server sends. Replaces any previous setting and probes immediately, so the response usually carries a first verdict. A failure is confirmed by a second probe before any rule fires. If the organization has no alert rule for keyword checks yet, an email rule is created so failures reach the key's creator.

put/v1/domains/{id}/keyword

Request

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

Path parameters

idstring required
Example:9b1d...

Opaque identifier.

Request body

keywordstring required

The text to look for. Matched against the raw HTML the server sends, not a rendered page.

mode'present' | 'absent'

What the page is expected to do with the text. present: it must contain the text, so the check fails when the text disappears (a login button, a product name). absent: it must not contain the text, so the check fails when the text appears ("Database error", "Out of stock").

caseSensitiveboolean
pathstring

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

enabledboolean

Pause the check without forgetting its settings.

Example request

{
  "keyword": "Add to cart",
  "path": "/checkout"
}

Response

The keyword 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.