Health Checks
List Health Checks
Health Check Details
Create Health Check
Update Health Check
Patch Health Check
Delete Health Check
ModelsExpand Collapse
HealthCheckListResponse = object { id, address, check_regions, 15 more }
check_regions: optional array of "WNAM" or "ENAM" or "WEU" or 11 moreA list of regions from which to run health checks. Null means Cloudflare will pick a default region.
A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
The number of consecutive fails required from a health check before changing the health to unhealthy.
The number of consecutive successes required from a health check before changing the health to healthy.
http_config: optional object { allow_insecure, expected_body, expected_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.
Parameters specific to an HTTP or HTTPS health check.
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.
The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
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.
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.
A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
status: optional "unknown" or "healthy" or "unhealthy" or "suspended"The current status of the origin server according to the health check.
The current status of the origin server according to the health check.
HealthCheckGetResponse = object { id, address, check_regions, 15 more }
check_regions: optional array of "WNAM" or "ENAM" or "WEU" or 11 moreA list of regions from which to run health checks. Null means Cloudflare will pick a default region.
A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
The number of consecutive fails required from a health check before changing the health to unhealthy.
The number of consecutive successes required from a health check before changing the health to healthy.
http_config: optional object { allow_insecure, expected_body, expected_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.
Parameters specific to an HTTP or HTTPS health check.
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.
The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
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.
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.
A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
status: optional "unknown" or "healthy" or "unhealthy" or "suspended"The current status of the origin server according to the health check.
The current status of the origin server according to the health check.
HealthCheckCreateResponse = object { id, address, check_regions, 15 more }
check_regions: optional array of "WNAM" or "ENAM" or "WEU" or 11 moreA list of regions from which to run health checks. Null means Cloudflare will pick a default region.
A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
The number of consecutive fails required from a health check before changing the health to unhealthy.
The number of consecutive successes required from a health check before changing the health to healthy.
http_config: optional object { allow_insecure, expected_body, expected_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.
Parameters specific to an HTTP or HTTPS health check.
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.
The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
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.
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.
A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
status: optional "unknown" or "healthy" or "unhealthy" or "suspended"The current status of the origin server according to the health check.
The current status of the origin server according to the health check.
HealthCheckUpdateResponse = object { id, address, check_regions, 15 more }
check_regions: optional array of "WNAM" or "ENAM" or "WEU" or 11 moreA list of regions from which to run health checks. Null means Cloudflare will pick a default region.
A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
The number of consecutive fails required from a health check before changing the health to unhealthy.
The number of consecutive successes required from a health check before changing the health to healthy.
http_config: optional object { allow_insecure, expected_body, expected_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.
Parameters specific to an HTTP or HTTPS health check.
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.
The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
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.
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.
A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
status: optional "unknown" or "healthy" or "unhealthy" or "suspended"The current status of the origin server according to the health check.
The current status of the origin server according to the health check.
HealthCheckEditResponse = object { id, address, check_regions, 15 more }
check_regions: optional array of "WNAM" or "ENAM" or "WEU" or 11 moreA list of regions from which to run health checks. Null means Cloudflare will pick a default region.
A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
The number of consecutive fails required from a health check before changing the health to unhealthy.
The number of consecutive successes required from a health check before changing the health to healthy.
http_config: optional object { allow_insecure, expected_body, expected_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.
Parameters specific to an HTTP or HTTPS health check.
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.
The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
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.
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.
A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
status: optional "unknown" or "healthy" or "unhealthy" or "suspended"The current status of the origin server according to the health check.
The current status of the origin server according to the health check.