Sign in

v1

latestOpenAPI 3.0.32026-07-13331437.0 KB
Monitors

Get a monitor

Retrieve details of a specific monitor.

get/v1/monitors/{uuid}

Path parameters

uuidstring required

Monitor UUID

Response

Monitor details

uuidstring
namestring
urlstring
protocol'http' | 'port' | 'icmp'
http_method'GET' | 'POST' | 'PUT' | 'HEAD' | 'DELETE' | 'PATCH' | 'OPTIONS'
check_frequencyinteger

Check interval in seconds

regionsstring[]
status'up' | 'down'
pausedboolean
expected_status_codestring

Use "2xx" for 200-299, "1xx-3xx" for 100-399, or a specific code like "200"

required_keywordstring
follow_redirectsboolean
portinteger nullable
ssl_expirationinteger

Days until SSL expiration

alerts_waitinteger

Minutes before alerting (-1 to disable)

Example response

{
  "uuid": "mon_OYKr5fpSDHqbP2",
  "name": "API",
  "url": "https://api.acme.com",
  "check_frequency": 30,
  "regions": [
    "paris",
    "london",
    "frankfurt"
  ],
  "expected_status_code": "2xx"
}