Skip to main content

Documentation Index

Fetch the complete documentation index at: https://monitor-f3599674.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Monitors are the core of the Monitor platform. Each monitor periodically checks a target URL and records the result — status, response time, and any assertion failures.

Check types

TypeDescription
EndpointHTTP/HTTPS request; validates status code and optional body assertions.
HealthChecks a JSON health endpoint, e.g. {"status":"ok"}.
PingICMP or TCP reachability check — no HTTP required.
KeywordValidates that the response body contains (or does not contain) a specific string.
SSLChecks TLS certificate validity and expiry.
PushA passive monitor; your service calls a heartbeat URL. Monitor raises an alert if no ping arrives within the configured TTL.

Creating a monitor

Go to Monitors → New Monitor (the form at the top of the page):

Step 1 — Basics

FieldDescription
Monitor nameHuman-readable label (e.g. API health)
URLThe target URL to check (must include http:// or https://)
Check typeOne of the types listed above
HTTP methodGET, POST, PUT, DELETE, or HEAD (not available for Push)
IntervalHow often the check runs, in minutes (minimum: 1)
TimeoutRequest timeout in milliseconds (1 000 – 30 000 ms)
Auto-recovery TTLFor Push monitors only: minutes before auto-resolving if no heartbeat arrives (0 to disable)

Step 2 — Checks

FieldDescription
Degraded thresholdResponse time (ms) above which the monitor is marked degraded
Expected statusHTTP status code to assert on (e.g. 200)
Body must containString that must appear in the response body
Body must not containString that must not appear in the response body
Request headersOne Key: Value header per line
Request bodyRaw body to send with the request (POST/PUT)
Response formatAuto, Text, or JSON
Response assertionPath-based assertion for JSON responses (contains, equals, regex, JSON path)
PublicShow this monitor on the public status page

Monitor statuses

StatusMeaning
upLast check passed
degradedCheck passed but response time exceeded the degraded threshold
downCheck failed (wrong status code, timeout, assertion failure, etc.)
pendingNo checks have run yet

Push monitors

Push monitors allow you to monitor services that can’t be reached from outside (e.g. background jobs, crons). Your service pings a unique heartbeat URL; if Monitor doesn’t receive a ping within the TTL window, the monitor is marked down. Heartbeat URL format:
GET /api/v1/push/{monitorId}?apiKey={apiKey}
Generate an API key in Settings → API Keys to authenticate push pings.