--- title: Create Health Check --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Healthchecks](https://developers.cloudflare.com/api/python/resources/healthchecks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Health Check healthchecks.create(HealthcheckCreateParams\*\*kwargs) -> [Healthcheck]() POST/zones/{zone\_id}/healthchecks Create a new health check. ##### 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` ##### ParametersExpand Collapse zone\_id: str Identifier maxLength32 [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) address: str The hostname or IP address of the origin server to run health checks on. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20address%20%3E%20(schema)>) name: str A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)

check\_regions: Optional\[List\[CheckRegion]] 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](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20check_regions%20%3E%20(schema)>) consecutive\_fails: Optional\[int] The number of consecutive fails required from a health check before changing the health to unhealthy. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20consecutive_fails%20%3E%20(schema)>) consecutive\_successes: Optional\[int] The number of consecutive successes required from a health check before changing the health to healthy. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20consecutive_successes%20%3E%20(schema)>) description: Optional\[str] A human-readable description of the health check. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20description%20%3E%20(schema)>)

http\_config: Optional\[HTTPConfigurationParam] Parameters specific to an HTTP or HTTPS health check.

allow\_insecure: Optional\[bool] Do not validate the certificate when the health check uses HTTPS. Link to this property expected\_body: Optional\[str] 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\[List\[str]] 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\[bool] Follow redirects if the origin returns a 3xx status code. Link to this property header: Optional\[Dict\[str, List\[str]]] 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\[Literal\["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: Optional\[str] The endpoint path to health check against. Link to this property port: Optional\[int] 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(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20http_config%20%3E%20(schema)>) interval: Optional\[int] 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](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20interval%20%3E%20(schema)>) retries: Optional\[int] 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](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20retries%20%3E%20(schema)>) suspended: Optional\[[bool]()] If suspended, no health checks are sent to the origin. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20suspended%20%3E%20(schema)>)

tcp\_config: Optional\[TCPConfigurationParam] Parameters specific to TCP health check.

method: Optional\[Literal\["connection\_established"]] The TCP connection method to use for the health check. Link to this property port: Optional\[int] 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(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20tcp_config%20%3E%20(schema)>) healthcheck\_timeout: Optional\[int] The timeout (in seconds) before marking the health check as failed. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20timeout%20%3E%20(schema)>) type: Optional\[str] The protocol to use for the health check. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. [Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20type%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class Healthcheck: …

id: Optional\[str] Identifier maxLength32 Link to this property address: Optional\[str] The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: Optional\[List\[CheckRegion]] A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

Link to this property consecutive\_fails: Optional\[int] The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property consecutive\_successes: Optional\[int] The number of consecutive successes required from a health check before changing the health to healthy. Link to this property created\_on: Optional\[datetime] formatdate-time Link to this property description: Optional\[str] A human-readable description of the health check. Link to this property failure\_reason: Optional\[str] The current failure reason if status is unhealthy. Link to this property

http\_config: Optional\[HTTPConfiguration] Parameters specific to an HTTP or HTTPS health check.

method: Optional\[Literal\["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 interval: Optional\[int] 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\[datetime] formatdate-time Link to this property name: Optional\[str] A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property retries: Optional\[int] 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\[Literal\["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: Optional\[bool] If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: Optional\[TCPConfiguration] Parameters specific to TCP health check.

Link to this property timeout: Optional\[int] The timeout (in seconds) before marking the health check as failed. Link to this property type: Optional\[str] 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)>) ### Create Health Check Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) healthcheck = client.healthchecks.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", address="www.example.com", name="server-1", ) print(healthcheck.id) ``` 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 } ``` ##### 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 } ```