Skip to content
Cloudflare API
Start here
API Reference

Healthchecks

List Health Checks
client.healthchecks.list(HealthcheckListParams { zone_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<Healthcheck { id, address, check_regions, 15 more } >
GET/zones/{zone_id}/healthchecks
Health Check Details
client.healthchecks.get(stringhealthcheckId, HealthcheckGetParams { zone_id } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
GET/zones/{zone_id}/healthchecks/{healthcheck_id}
Create Health Check
client.healthchecks.create(HealthcheckCreateParams { zone_id, address, name, 11 more } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
POST/zones/{zone_id}/healthchecks
Update Health Check
client.healthchecks.update(stringhealthcheckId, HealthcheckUpdateParams { zone_id, address, name, 11 more } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
PUT/zones/{zone_id}/healthchecks/{healthcheck_id}
Patch Health Check
client.healthchecks.edit(stringhealthcheckId, HealthcheckEditParams { zone_id, address, name, 11 more } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
PATCH/zones/{zone_id}/healthchecks/{healthcheck_id}
Delete Health Check
client.healthchecks.delete(stringhealthcheckId, HealthcheckDeleteParams { zone_id } params, RequestOptionsoptions?): HealthcheckDeleteResponse { id }
DELETE/zones/{zone_id}/healthchecks/{healthcheck_id}
ModelsExpand Collapse
CheckRegion = "WNAM" | "ENAM" | "WEU" | 11 more

WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).

One of the following:
"WNAM"
"ENAM"
"WEU"
"EEU"
"NSAM"
"SSAM"
"OC"
"ME"
"NAF"
"SAF"
"IN"
"SEAS"
"NEAS"
"ALL_REGIONS"
Healthcheck { id, address, check_regions, 15 more }
id?: string

Identifier

maxLength32
address?: string

The hostname or IP address of the origin server to run health checks on.

check_regions?: Array<CheckRegion> | null

A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

One of the following:
"WNAM"
"ENAM"
"WEU"
"EEU"
"NSAM"
"SSAM"
"OC"
"ME"
"NAF"
"SAF"
"IN"
"SEAS"
"NEAS"
"ALL_REGIONS"
consecutive_fails?: number

The number of consecutive fails required from a health check before changing the health to unhealthy.

consecutive_successes?: number

The number of consecutive successes required from a health check before changing the health to healthy.

created_on?: string
formatdate-time
description?: string

A human-readable description of the health check.

failure_reason?: string

The current failure reason if status is unhealthy.

http_config?: HTTPConfiguration { allow_insecure, expected_body, expected_codes, 5 more } | null

Parameters specific to an HTTP or HTTPS health check.

interval?: number

The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.

modified_on?: string
formatdate-time
name?: string

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

retries?: number

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

status?: "unknown" | "healthy" | "unhealthy" | "suspended"

The current status of the origin server according to the health check.

One of the following:
"unknown"
"healthy"
"unhealthy"
"suspended"
suspended?: boolean

If suspended, no health checks are sent to the origin.

tcp_config?: TCPConfiguration { method, port } | null

Parameters specific to TCP health check.

timeout?: number

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

type?: string

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

HTTPConfiguration { allow_insecure, expected_body, expected_codes, 5 more }

Parameters specific to an HTTP or HTTPS health check.

allow_insecure?: boolean

Do not validate the certificate when the health check uses HTTPS.

expected_body?: string

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.

expected_codes?: Array<string> | null

The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.

follow_redirects?: boolean

Follow redirects if the origin returns a 3xx status code.

header?: Record<string, Array<string>> | null

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.

method?: "GET" | "HEAD"

The HTTP method to use for the health check.

One of the following:
"GET"
"HEAD"
path?: string

The endpoint path to health check against.

port?: number

Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.

QueryHealthcheck { address, name, check_regions, 10 more }
address: string

The hostname or IP address of the origin server to run health checks on.

name: string

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

check_regions?: Array<CheckRegion> | null

A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

One of the following:
"WNAM"
"ENAM"
"WEU"
"EEU"
"NSAM"
"SSAM"
"OC"
"ME"
"NAF"
"SAF"
"IN"
"SEAS"
"NEAS"
"ALL_REGIONS"
consecutive_fails?: number

The number of consecutive fails required from a health check before changing the health to unhealthy.

consecutive_successes?: number

The number of consecutive successes required from a health check before changing the health to healthy.

description?: string

A human-readable description of the health check.

http_config?: HTTPConfiguration { allow_insecure, expected_body, expected_codes, 5 more } | null

Parameters specific to an HTTP or HTTPS health check.

interval?: number

The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.

retries?: number

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

suspended?: boolean

If suspended, no health checks are sent to the origin.

tcp_config?: TCPConfiguration { method, port } | null

Parameters specific to TCP health check.

timeout?: number

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

type?: string

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

TCPConfiguration { method, port }

Parameters specific to TCP health check.

method?: "connection_established"

The TCP connection method to use for the health check.

port?: number

Port number to connect to for the health check. Defaults to 80.

HealthcheckDeleteResponse { id }
id?: string

Identifier

maxLength32

HealthchecksPreviews

Health Check Preview Details
client.healthchecks.previews.get(stringhealthcheckId, PreviewGetParams { zone_id } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
GET/zones/{zone_id}/healthchecks/preview/{healthcheck_id}
Create Preview Health Check
client.healthchecks.previews.create(PreviewCreateParams { zone_id, address, name, 11 more } params, RequestOptionsoptions?): Healthcheck { id, address, check_regions, 15 more }
POST/zones/{zone_id}/healthchecks/preview
Delete Preview Health Check
client.healthchecks.previews.delete(stringhealthcheckId, PreviewDeleteParams { zone_id } params, RequestOptionsoptions?): PreviewDeleteResponse { id }
DELETE/zones/{zone_id}/healthchecks/preview/{healthcheck_id}
ModelsExpand Collapse
PreviewDeleteResponse { id }
id?: string

Identifier

maxLength32