--- title: List Health Checks --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Smart Shield](https://developers.cloudflare.com/api/resources/smart_shield) [Health Checks](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Health Checks GET/zones/{zone\_id}/smart\_shield/healthchecks List configured health checks. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Health Checks Write``Health Checks Read` ##### P ath ParametersExpand Collapse zone\_id: string Identifier. maxLength32 [Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse page: optional number Page number of paginated results. minimum1 [Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: optional number Maximum number of results per page. Must be a multiple of 5. maximum1000 minimum5 [Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) ##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: array of object {id, address, check\_regions, 15 more } id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property
check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region. One of the following: "WNAM" Link to this property "ENAM" Link to this property "WEU" Link to this property "EEU" Link to this property "NSAM" Link to this property "SSAM" Link to this property "OC" Link to this property "ME" Link to this property "NAF" Link to this property "SAF" Link to this property "IN" Link to this property "SEAS" Link to this property "NEAS" Link to this property "ALL\_REGIONS" Link to this property
Link to this property consecutive\_fails: optional number The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property consecutive\_successes: optional number The number of consecutive successes required from a health check before changing the health to healthy. Link to this property created\_on: optional string formatdate-time Link to this property description: optional string A human-readable description of the health check. Link to this property failure\_reason: optional string The current failure reason if status is unhealthy. Link to this property
http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check. allow\_insecure: optional boolean Do not validate the certificate when the health check uses HTTPS. Link to this property expected\_body: optional 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. Link to this property expected\_codes: optional array of string The expected HTTP response codes (e.g. “200”) or code ranges (e.g. “2xx” for all codes starting with 2) of the health check. Link to this property follow\_redirects: optional boolean Follow redirects if the origin returns a 3xx status code. Link to this property header: optional map\[array of string] 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. Link to this property
method: optional "GET"or "HEAD" The HTTP method to use for the health check. One of the following: "GET" Link to this property "HEAD" Link to this property
Link to this property path: optional string The endpoint path to health check against. Link to this property port: optional number Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS. Link to this property
Link to this property interval: optional 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. Link to this property modified\_on: optional string formatdate-time Link to this property name: optional string A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property retries: optional number The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Link to this property
status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check. One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property
Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property
tcp\_config: optional object {method, port } Parameters specific to TCP health check. method: optional "connection\_established" The TCP connection method to use for the health check. Link to this property port: optional number Port number to connect to for the health check. Defaults to 80. Link to this property
Link to this property timeout: optional number The timeout (in seconds) before marking the health check as failed. Link to this property type: optional string The protocol to use for the health check. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. Link to this property
[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, total\_count } count: optional number Total number of results for the requested service Link to this property page: optional number Current page within paginated list of results Link to this property per\_page: optional number Number of results per page of results Link to this property total\_count: optional number Total results available without any search parameters Link to this property
[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) ### List Health Checks HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/smart_shield/healthchecks \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "address": "www.example.com", "check_regions": [ "WEU", "ENAM" ], "consecutive_fails": 0, "consecutive_successes": 0, "created_on": "2014-01-01T05:20:00.12345Z", "description": "Health check for www.example.com", "failure_reason": "", "http_config": { "allow_insecure": true, "expected_body": "success", "expected_codes": [ "2xx", "302" ], "follow_redirects": true, "header": { "Host": [ "example.com" ], "X-App-ID": [ "abc123" ] }, "method": "GET", "path": "/health", "port": 0 }, "interval": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "name": "server-1", "retries": 0, "status": "healthy", "suspended": true, "tcp_config": { "method": "connection_established", "port": 0 }, "timeout": 0, "type": "HTTPS" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "address": "www.example.com", "check_regions": [ "WEU", "ENAM" ], "consecutive_fails": 0, "consecutive_successes": 0, "created_on": "2014-01-01T05:20:00.12345Z", "description": "Health check for www.example.com", "failure_reason": "", "http_config": { "allow_insecure": true, "expected_body": "success", "expected_codes": [ "2xx", "302" ], "follow_redirects": true, "header": { "Host": [ "example.com" ], "X-App-ID": [ "abc123" ] }, "method": "GET", "path": "/health", "port": 0 }, "interval": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "name": "server-1", "retries": 0, "status": "healthy", "suspended": true, "tcp_config": { "method": "connection_established", "port": 0 }, "timeout": 0, "type": "HTTPS" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```