Domains

List a website's monitors

The scheduled checks, with their cadence, next slot and latest outcome. Uptime, DNS, the keyword, content and port checks keep their detail here; the certificate and registration project onto the website itself. The keyword, content and port checks carry their config once set, and are enabled: false until then; the uptime check carries one once it has HTTP options.

get/v1/domains/{id}/monitors

Request

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

Path parameters

idstring required
Example:9b1d...

Opaque identifier.

Response

The monitors.

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.