--- title: Healthchecks --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Healthchecks ##### [List Health Checks](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/edit) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/methods/delete) 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" 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](<#(resource)%20healthchecks%20%3E%20(model)%20check_region%20%3E%20(schema)>)

Healthcheck {id, address, check\_regions, 15 more }

id?: string Identifier maxLength32 Link to this property address?: string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions?: Array<CheckRegion>| null A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

Link to this property consecutive\_fails?: number The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property consecutive\_successes?: number The number of consecutive successes required from a health check before changing the health to healthy. Link to this property created\_on?: string formatdate-time Link to this property description?: string A human-readable description of the health check. Link to this property failure\_reason?: string The current failure reason if status is unhealthy. Link to this property http\_config?: HTTPConfiguration {allow\_insecure, expected\_body, expected\_codes, 5 more } | null Parameters specific to an HTTP or HTTPS health check. Link to this property 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. Link to this property modified\_on?: string formatdate-time Link to this property name?: string A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property retries?: 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?: "unknown"| "healthy"| "unhealthy"| "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?: boolean If suspended, no health checks are sent to the origin. Link to this property tcp\_config?: TCPConfiguration {method, port } | null Parameters specific to TCP health check. Link to this property timeout?: number The timeout (in seconds) before marking the health check as failed. Link to this property type?: 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)%20healthchecks%20%3E%20(model)%20healthcheck%20%3E%20(schema)>)

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. Link to this property 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. Link to this property 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. Link to this property follow\_redirects?: boolean Follow redirects if the origin returns a 3xx status code. Link to this property 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. Link to this property

method?: "GET"| "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?: string The endpoint path to health check against. Link to this property port?: 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](<#(resource)%20healthchecks%20%3E%20(model)%20http_configuration%20%3E%20(schema)>)

QueryHealthcheck {address, name, check\_regions, 10 more }

address: string The hostname or IP address of the origin server to run health checks on. Link to this property name: string A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property

check\_regions?: Array<CheckRegion>| null A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

Link to this property consecutive\_fails?: number The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property consecutive\_successes?: number The number of consecutive successes required from a health check before changing the health to healthy. Link to this property description?: string A human-readable description of the health check. Link to this property http\_config?: HTTPConfiguration {allow\_insecure, expected\_body, expected\_codes, 5 more } | null Parameters specific to an HTTP or HTTPS health check. Link to this property 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. Link to this property retries?: 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 suspended?: boolean If suspended, no health checks are sent to the origin. Link to this property tcp\_config?: TCPConfiguration {method, port } | null Parameters specific to TCP health check. Link to this property timeout?: number The timeout (in seconds) before marking the health check as failed. Link to this property type?: 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)%20healthchecks%20%3E%20(model)%20query_healthcheck%20%3E%20(schema)>)

TCPConfiguration {method, port } Parameters specific to TCP health check.

method?: "connection\_established" The TCP connection method to use for the health check. Link to this property port?: number Port number to connect to for the health check. Defaults to 80. Link to this property

[Link to this property](<#(resource)%20healthchecks%20%3E%20(model)%20tcp_configuration%20%3E%20(schema)>)

HealthcheckDeleteResponse {id }

id?: string Identifier maxLength32 Link to this property

[Link to this property](<#(resource)%20healthchecks%20%3E%20(model)%20healthcheck_delete_response%20%3E%20(schema)>) #### HealthchecksPreviews ##### [Health Check Preview Details](https://developers.cloudflare.com/api/typescript/resources/healthchecks/subresources/previews/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/subresources/previews/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/healthchecks/subresources/previews/methods/delete) 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 Link to this property

[Link to this property](<#(resource)%20healthchecks.previews%20%3E%20(model)%20preview_delete_response%20%3E%20(schema)>)