GET/v1/monitors/{monitor_uuid}

Get a monitor

Returns details for a specific monitor.

Request

Path Parameters

uuidstringrequired

The unique identifier of the monitor

Example:"mon_3GhAQMYGEQuyUH"

Response

Returns the monitor object if a valid identifier was provided.

Monitor Objectapplication/json

uuidstring

Unique identifier for the monitor

namestring

Monitor name

urlstring

Monitored URL or host

protocolenum<string>

Protocol type

Possible values:

httpporticmpdns

dns_record_typestring

DNS record type (A, AAAA, CNAME, MX, NS, TXT, etc.). Present when protocol is dns

dns_nameserverstring

Nameserver used for DNS queries. Present when protocol is dns

dns_expected_answerstring

Expected DNS answer to validate against. Present when protocol is dns

http_methodstring

HTTP method used for the request

check_frequencynumber

Check interval in seconds

regionsarray<string>

Monitoring regions

statusenum<string>

Current status of the monitor

Possible values:

updown

request_headersarray<object>

Custom HTTP headers

request_bodystring

Request body content

ssl_expirationnumber

Whole days until the TLS certificate expires, rounded down (0 = within 24 hours, negative = expired). null for non-HTTP monitors.

ssl_alert_daysnumber

Days before certificate expiry the first alert goes out. -1 = never.

ssl_remindersboolean

Whether reminders follow the first expiry alert.

ssl_notify_on_changeboolean

Whether a certificate change sends a notification.

domain_alert_daysnumber

Days before the domain registration expires to alert. -1 = never.

domain_expirationnumber

Whole days until the domain registration expires. null when unknown or not published by the registry.

required_keywordstring

Triggers downtime if body response is missing this keyword

escalation_policyobject

Linked escalation policy with uuid and name

RequestcURL

curl https://api.hyperping.io/v1/monitors/mon_3GhAQMYGEQuyUH \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

{
  "name": "Website",
  "url": "https://www.acme.com",
  "uuid": "mon_3GhAQMYGEQuyUH",
  "protocol": "http",
  "projectUuid": "0109c1f0-b521-44f4-9681-9046aa6f51d8",
  "port": null,
  "http_method": "GET",
  "regions": [
    "amsterdam",
    "london",
    "paris",
    "frankfurt"
  ],
  "check_frequency": 30,
  "follow_redirects": true,
  "expected_status_code": "2xx",
  "request_body": "{ \"key\": \"value\" }",
  "request_headers": [
    {
      "name": "cache-control",
      "value": "no-cache"
    }
  ],
  "status": "up",
  "ssl_expiration": 365,
  "ssl_alert_days": 30,
  "ssl_reminders": true,
  "ssl_notify_on_change": false,
  "domain_alert_days": 30,
  "domain_expiration": 214,
  "required_keyword": "",
  "escalation_policy": {
    "uuid": "policy_EGy0NOiHLLYiva",
    "name": "On-Call DevOps"
  }
}

← List monitors Create a monitor →