Monitors are called IP monitors inside the API.
health
change. (Read-only)uri
is http
or https
.mon_sample123456
. (Read-only)ip_monitor
. (Read-only)external_ref
.health
.nameserver_set_id
.id
(default), name
.GET /v1/ip_monitors
On success, 200 with 0 or more IP monitors.
{
"collection": [
{
"external_ref": null,
"health": "online",
"health_at": 1640995200,
"hostname": "example.com",
"id": "mon_sample123456",
"name": "Example",
"nameserver_set_id": "nst_sample123456",
"object": "ip_monitor",
"uri": "https://192.0.2.1/path"
}
],
"more_results": false
}
GET /v1/ip_monitors/mon_sample123456
On success, 200 with the IP monitor.
{
"external_ref": null,
"health": "online",
"health_at": 1640995200,
"hostname": "example.com",
"id": "mon_sample123456",
"in_use": false,
"name": "Example",
"nameserver_set_id": "nst_sample123456",
"object": "ip_monitor",
"uri": "https://192.0.2.1/path"
}
POST /v1/ip_monitors
{
"ip_monitor": {
"name": "Example host",
"nameserver_set_id": "nst_sample123456",
"uri": "ping://192.0.2.2"
}
}
On success, 201 with the new IP monitor.
On error, 422 with standard error response.
{
"external_ref": null,
"health": "unknown",
"health_at": 1640995200,
"hostname": null,
"id": "mon_sample123456",
"in_use": false,
"name": "Example host",
"nameserver_set_id": "nst_sample123456",
"object": "ip_monitor",
"uri": "ping://192.0.2.2"
}
PUT /v1/ip_monitors/mon_sample123456
{
"ip_monitor": {
"name": "Example"
}
}
On success, 200 with the updated IP monitor.
On error, 422 with standard error response.
{
"external_ref": null,
"health": "online",
"health_at": 1640995200,
"hostname": "example.com",
"id": "mon_sample123456",
"in_use": false,
"name": "Example",
"nameserver_set_id": "nst_sample123456",
"object": "ip_monitor",
"uri": "https://192.0.2.1/path"
}
DELETE /v1/ip_monitors/mon_sample123456
On success, 202 with an empty response.
On error, 422 with standard error response.