GET/v1/monitors

Get all monitors

Returns a list of all monitors for a project.

Request

Every parameter is optional. Without any, the endpoint returns all the monitors of the project; each filter narrows the list, and they combine.

Query Parameters

protocolenum<string>optional

Only monitors of this type

Available options:

httpporticmpdnsbrowser

group_idnumberoptional

Only monitors of this monitor group

external_idstringoptional

The monitor with this external_id, as a list of zero or one

Response

Returns an array of monitor objects.

Monitor Object Fieldsapplication/json

uuidstring

Unique identifier for the monitor

external_idstring

Your own identifier for the monitor, or null

namestring

Monitor name

urlstring

Monitored URL or host

protocolenum<string>

Protocol type

Possible values:

httpporticmpdnsbrowser

dns_record_typestring

DNS record type. Present when protocol is dns

dns_nameserverstring

Nameserver for DNS queries. Present when protocol is dns

dns_expected_answerstring

Expected DNS answer. 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

pausedboolean

Whether monitoring is paused

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.

escalation_policyobject

Linked escalation policy with uuid and name

env_variablesarray<object>

The name of each variable of a browser check, never the values. Present when protocol is browser. The script of a browser check is not in the list: Get a monitor returns it.

RequestcURL

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

# Only the browser checks of group 12
curl "https://api.hyperping.io/v1/monitors?protocol=browser&group_id=12" \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

[
  {
    "name": "API",
    "url": "https://api.acme.com",
    "uuid": "mon_OYKr5fpSDHqbP2",
    "external_id": null,
    "paused": false,
    "protocol": "http",
    "projectUuid": "proj_IU6NdRUvdZSWz7",
    "port": null,
    "http_method": "GET",
    "regions": [
      "amsterdam",
      "london",
      "paris",
      "frankfurt"
    ],
    "check_frequency": 30,
    "follow_redirects": true,
    "ip_version": 4,
    "expected_status_code": "2xx",
    "request_body": "",
    "request_headers": [],
    "status": "up",
    "ssl_expiration": 365,
    "ssl_alert_days": 30,
    "ssl_reminders": true,
    "ssl_notify_on_change": false,
    "domain_alert_days": 30,
    "domain_expiration": 214,
    "alerts_wait": 0,
    "escalation_policy": {
      "uuid": "policy_EGy0NOiHLLYiva",
      "name": "On-Call DevOps"
    }
  }
]

← Monitors API Get a monitor →