Preview Pool - Cloudflare

Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

Request

Path Params

identifier

string

required

account_identifier

string

required

Body Params application/json

allow_insecure

boolean

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

expected_body

string

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

required

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

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"]}

method

string

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

path

string

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

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

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

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

optional

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

Default:

type

enum<string>

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

Example

{
    "allow_insecure": true,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "header": {
        "Host": [
            "example.com"
        ],
        "X-App-ID": [
            "abc123"
        ]
    },
    "method": "GET",
    "path": "/health",
    "port": 0,
    "probe_zone": "example.com",
    "retries": 2,
    "timeout": 5,
    "type": "https"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Preview Pool response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "pools": {
            "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
            "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
        },
        "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
    },
    "success": true
}

🟢200Preview Pool response failure