List Monitors

List configured monitors for an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (components-schemas-monitor) {19}]

allOf {2}

One of

array[object (components-schemas-monitor) {19}]

object

allow_insecure

boolean

allow_insecure

optional

Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

Default:

false

Example:

true

consecutive_down

integer

consecutive_down

optional

To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

Default:

consecutive_up

integer

consecutive_up

optional

To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

Default:

created_on

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

description

string

monitor_components-schemas-description

optional

Object description.

Example:

expected_body

string

expected_body

optional

A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

Example:

alive

expected_codes

string

schemas-expected_codes

optional

The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.

Default:

200

Example:

2xx

follow_redirects

boolean

follow_redirects

optional

Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

Default:

false

Example:

true

header

object

header

optional

The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

Example:

{"Host":["example.com"],"X-App-ID":["abc123"]}

monitor_components-schemas-identifier

optional

Example:

f1aba936b94213e5b8dca0c0dbf1f9cc

interval

integer

interval

optional

The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

Default:

method

string

schemas-method

optional

The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

Default:

GET

Example:

GET

modified_on

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

path

string

path

optional

The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

Default:

Example:

/health

port

integer

monitor_components-schemas-port

optional

The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

Default:

probe_zone

string

probe_zone

optional

Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

Example:

example.com

retries

integer

schemas-retries

optional

The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

Default:

timeout

integer

schemas-timeout

optional

The timeout (in seconds) before marking the health check as failed.

Default:

type

enum<string>

monitor_components-schemas-type

optional

The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

Allowed values:

httphttpstcpudp_icmpicmp_pingsmtp

Default:

http

Example:

https

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "allow_insecure": true,
            "consecutive_down": 0,
            "consecutive_up": 0,
            "created_on": "2014-01-01T05:20:00.12345Z",
            "description": "Login page monitor",
            "expected_body": "alive",
            "expected_codes": "2xx",
            "follow_redirects": true,
            "header": {
                "Host": [
                    "example.com"
                ],
                "X-App-ID": [
                    "abc123"
                ]
            },
            "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
            "interval": 60,
            "method": "GET",
            "modified_on": "2014-01-01T05:20:00.12345Z",
            "path": "/health",
            "port": 0,
            "probe_zone": "example.com",
            "retries": 2,
            "timeout": 5,
            "type": "https"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses