Monitors / Get

Fetch one monitor by guid and monitor_type. Does not include status; use /monitors/status for that.

Endpoint

Method POST
Url https://downdar.com/api/v1/monitors/get

Request

Key fields

guid key Monitor id.
monitor_type key http, ping, tcp, ssl, or dns.
{ "guid": "550e8400-e29b-41d4-a716-446655440000", "monitor_type": "http" }

Response

Top level

ok Always true on success.
monitor Full monitor object. Fields below apply to monitor.
rate_limit Rate limit state for the tier this endpoint consumes. Present on every successful response.

monitor

guid Monitor id.
monitor_type http, ping, tcp, ssl, or dns.
name String, max 255 characters.
interval_seconds 60, 300, 600, 900, 1800, 3600, 7200, 86400.
region_mode rotate or selected.
region_ids Array of region id integers when region_mode is selected.
group_id Integer group id, or 0 for none.
tag_ids Array of integer tag ids.
alert_channel_keys Array of alert channel key strings.
paused true when checks are paused.

monitor HTTP fields

url HTTP or HTTPS URL, max 2048 characters.
method GET or POST.
expected_status Integer HTTP status code, 100-599.

monitor Ping fields

host Hostname or IP address.

monitor TCP fields

host Hostname or IP address.
port Integer, 1-65535.

monitor SSL fields

host Hostname or IP address.

monitor DNS fields

hostname Hostname to look up.
record_type A, AAAA, CNAME, MX, NS, TXT, or PTR.

rate_limit

tier Rate tier this endpoint counts against (1-5).
cost Units consumed by this request against the tier window.
timeframe Rolling limit window: second, minute, hour, or day.
limit Maximum units allowed in the timeframe for this tier on your plan.
used Units already used in the current window.
remaining Units left before this tier returns HTTP 429.
{ "ok": true, "monitor": { "guid": "550e8400-e29b-41d4-a716-446655440000", "monitor_type": "http", "name": "Homepage", "interval_seconds": 300, "region_mode": "rotate", "region_ids": [], "group_id": 0, "tag_ids": [], "alert_channel_keys": [], "paused": false, "url": "https://example.com/", "method": "GET", "expected_status": 200 }, "rate_limit": { "tier": 3, "cost": 1, "timeframe": "minute", "limit": 300, "used": 45, "remaining": 255 } }