API & MCP

Check types

Every monitor can run these checks. Uptime and SSL start on; switch the rest on from the monitor's sidebar, or send the fields below to PATCH /api/v1/monitors/{id} (or the update-monitor and enable-check MCP tools).

Only the fields you send change, and each check type you touch queues its first check, as saving it in the dashboard does. Validation is the same as the dashboard's: an invalid value is a 422 naming the field.

curl -X PATCH https://observe.live/api/v1/monitors/MONITOR_ID \
  -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" \
  -d '{"domain_monitoring_enabled": true, "lighthouse_monitoring_enabled": true, "lighthouse_strategy": "desktop"}'

Uptime

Requests the URL and expects one of your status codes, optionally with a method, body and headers, text that must or must not appear, JSON values and response headers. Alerts when it fails a number of times in a row (or for a number of minutes), and when it gets slower than a threshold or a percentage above its usual time.

Schedule: Every 1 to 60 minutes (uptime_interval_minutes, default 5). 1-minute checks depend on your plan.

Results: GET /monitors/{id}/uptime, GET /monitors/{id}/sla; run now with POST /monitors/{id}/check {"type": "uptime"}

uptime_monitoring_enabled boolean
uptime_interval_minutes integer | null 1–60
uptime_check_method string | null one of GET, POST, PUT, PATCH
uptime_check_body string | null up to 10000 characters
uptime_check_headers object | array | string | null "text/html"}. Objects are stored as sent; a string must be JSON.
uptime_check_string string | null up to 500 characters
uptime_check_absent_string string | null up to 500 characters
uptime_check_json_assertions object | array | string | null "status", "expected": "ok"}]. Objects are stored as sent; a string must be JSON.
uptime_check_header_patterns object | array | string | null "Content-Type", "pattern": "text/html"}]. Objects are stored as sent; a string must be JSON.
uptime_expected_codes string | null up to 100 characters
uptime_response_time_threshold_ms integer | null 0–
uptime_response_time_variance_pct integer | null 1–1000
uptime_alert_after_failures integer | null 1–10
uptime_alert_after_minutes integer | null 1–60
uptime_timeout_seconds integer | null 1–30
uptime_max_redirects integer | null 0–10

SSL

Reads the certificate: validity, expiry, issuer, hostname match, TLS version and weak signatures. Alerts when it is invalid or expires within ssl_expiring_soon_days. A replaced certificate alerts only when the CA changes, the key, signature or name list gets weaker, or it expires sooner or soon; a routine same-CA renewal is recorded on the SSL timeline without an alert unless ssl_alert_on_every_change is on.

Schedule: An hourly sweep re-reads each certificate once ssl_interval_minutes (15 to 1,440) have passed since its last check.

Results: GET /monitors/{id}/ssl; run now with POST /monitors/{id}/check {"type": "ssl"}

ssl_monitoring_enabled boolean
ssl_interval_minutes integer | null 15–1440
ssl_expiring_soon_days integer | null 1–90
ssl_alert_on_every_change boolean

Heartbeat

Waits for your cron job or worker to call its ping URL (heartbeat.ping_url on the monitor; GET or POST, or append /starting and /failed). Alerts when a ping is late by more than the grace period, or a job reports a failure.

Schedule: Expected every heartbeat_interval_minutes, or on a cron expression in a timezone; late pings are looked for every minute.

Results: GET /monitors/{id}/heartbeats

heartbeat_enabled boolean
heartbeat_interval_minutes integer | null 1–1440
heartbeat_grace_minutes integer | null 0–60
heartbeat_cron_expression string | null up to 120 characters
heartbeat_timezone string | null IANA timezone

Crawl

Follows internal links (and the sitemap) to find broken pages and links, mixed content, console errors, Lighthouse regressions and visual changes, within page, depth and time limits.

Schedule: Every crawl_interval_minutes (at least 60) when set; otherwise only when you start one (POST /monitors/{id}/check with type crawl).

Results: GET /monitors/{id}/crawls, GET /monitors/{id}/crawls/{crawl}/pages?filter=broken; run now with POST /monitors/{id}/check {"type": "crawl"}

crawl_monitoring_enabled boolean
crawl_max_depth integer | null 1–20
crawl_max_pages integer | null 10–50000
crawl_time_limit_minutes integer | null stop after this many minutes; 5–240
crawl_interval_minutes integer | null 60–525600
crawl_alert_on_broken boolean
crawl_alert_on_mixed_content boolean
crawl_alert_on_console_errors boolean
crawl_alert_on_lighthouse_regression boolean
crawl_alert_on_screenshot_diff boolean
crawl_lighthouse_regression_threshold integer | null 0–100
crawl_screenshot_diff_threshold_pct integer | null 1–100
crawl_seed_from_sitemap boolean
crawl_respect_robots_txt boolean
crawl_check_external_links boolean
crawl_ignore_patterns array | string | null URL patterns to skip, e.g. ["/admin/*"] (or one per line), up to 100
crawl_request_headers object | array | string | null "Bearer …"}. Objects are stored as sent; a string must be JSON.

Lighthouse

Runs a Lighthouse audit (mobile or desktop) for performance, accessibility, best practices and SEO, and alerts when a score or Core Web Vital crosses your thresholds.

Schedule: Daily.

Results: GET /monitors/{id}/lighthouse; run now with POST /monitors/{id}/check {"type": "lighthouse"}

lighthouse_monitoring_enabled boolean
lighthouse_strategy string one of mobile, desktop
lighthouse_thresholds object keys: min_score, max_fcp_ms, max_lcp_ms, max_tbt_ms, max_cls

Sitemap

Fetches the sitemap and reports whether it is reachable and valid, how many URLs it lists, and the listed URLs that fail.

Schedule: Daily.

Results: GET /monitors/{id}/sitemap; run now with POST /monitors/{id}/check {"type": "sitemap"}

sitemap_monitoring_enabled boolean

Robots.txt

Fetches robots.txt and alerts when it becomes unreachable or its rules change.

Schedule: Daily.

Results: GET /monitors/{id}/robots; run now with POST /monitors/{id}/check {"type": "robots"}

robots_txt_monitoring_enabled boolean

Domain

Looks up the domain's registration (RDAP) and alerts before it expires.

Schedule: Every 4 hours.

Results: GET /monitors/{id}/domain; run now with POST /monitors/{id}/check {"type": "domain"}

domain_monitoring_enabled boolean

DNS records

Snapshots the domain's DNS records and alerts when they change.

Schedule: Daily.

Results: GET /monitors/{id}/dns; run now with POST /monitors/{id}/check {"type": "dns-record"}

dns_record_monitoring_enabled boolean

DNS blocklist

Checks the domain and its mail IP against major DNS blocklists and alerts when either is listed.

Schedule: Daily.

Results: GET /monitors/{id}/blocklist; run now with POST /monitors/{id}/check {"type": "dns-blocklist"}

dns_blocklist_monitoring_enabled boolean

Reverse monitor

Opens a TCP connection to a host and port (a database, SSH, a mail server) to confirm it is reachable, or that it is not exposed.

Schedule: Every 5 minutes.

Results: GET /monitors/{id}/reverse; run now with POST /monitors/{id}/check {"type": "reverse-monitor"}

reverse_monitoring_enabled boolean
reverse_monitor_host string | null up to 255 characters
reverse_monitor_port integer | null 1–65535

Status page

Publishes a public page for this one monitor at /s/{slug}, showing the parts you choose: uptime, SSL, heartbeat and incident history. Organization-wide and additional status pages are under Status pages in the API.

Schedule: Always on while enabled.

status_page_enabled boolean
status_slug string | null up to 64 characters
status_page_title string | null up to 255 characters
status_page_message string | null up to 500 characters
status_page_show array | null any of uptime, ssl, heartbeat, incidents