--- title: Create Health Check --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Healthchecks](https://developers.cloudflare.com/api/go/resources/healthchecks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Health Check client.Healthchecks.New(ctx, params) (\*[Healthcheck](), error) 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
params HealthcheckNewParams ZoneID param.Field\[string] Path param: Identifier maxLength32 Link to this property QueryHealthcheck param.Field\[QueryHealthcheck] Body param Link to this property
[Link to this property](<#(resource)%20healthchecks%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Healthcheck struct{…} ID stringOptional Identifier maxLength32 Link to this property Address stringOptional The hostname or IP address of the origin server to run health checks on. Link to this property
CheckRegions \[]CheckRegionOptional A list of regions from which to run health checks. Null means Cloudflare will pick a default region. One of the following: const CheckRegionWnam CheckRegion = "WNAM" Link to this property const CheckRegionEnam CheckRegion = "ENAM" Link to this property const CheckRegionWeu CheckRegion = "WEU" Link to this property const CheckRegionEeu CheckRegion = "EEU" Link to this property const CheckRegionNsam CheckRegion = "NSAM" Link to this property const CheckRegionSsam CheckRegion = "SSAM" Link to this property const CheckRegionOc CheckRegion = "OC" Link to this property const CheckRegionMe CheckRegion = "ME" Link to this property const CheckRegionNaf CheckRegion = "NAF" Link to this property const CheckRegionSaf CheckRegion = "SAF" Link to this property const CheckRegionIn CheckRegion = "IN" Link to this property const CheckRegionSeas CheckRegion = "SEAS" Link to this property const CheckRegionNeas CheckRegion = "NEAS" Link to this property const CheckRegionAllRegions CheckRegion = "ALL\_REGIONS" Link to this property
Link to this property ConsecutiveFails int64Optional The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property ConsecutiveSuccesses int64Optional The number of consecutive successes required from a health check before changing the health to healthy. Link to this property CreatedOn TimeOptional formatdate-time Link to this property Description stringOptional A human-readable description of the health check. Link to this property FailureReason stringOptional The current failure reason if status is unhealthy. Link to this property
HTTPConfig HTTPConfigurationOptional Parameters specific to an HTTP or HTTPS health check. AllowInsecure boolOptional Do not validate the certificate when the health check uses HTTPS. Link to this property ExpectedBody stringOptional 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 ExpectedCodes \[]stringOptional 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 FollowRedirects boolOptional Follow redirects if the origin returns a 3xx status code. Link to this property Header map\[string, \[]string]Optional 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 HTTPConfigurationMethodOptional The HTTP method to use for the health check. One of the following: const HTTPConfigurationMethodGet HTTPConfigurationMethod = "GET" Link to this property const HTTPConfigurationMethodHead HTTPConfigurationMethod = "HEAD" Link to this property
Link to this property Path stringOptional The endpoint path to health check against. Link to this property Port int64Optional 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 int64Optional 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 ModifiedOn TimeOptional formatdate-time Link to this property Name stringOptional A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property Retries int64Optional 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 HealthcheckStatusOptional The current status of the origin server according to the health check. One of the following: const HealthcheckStatusUnknown HealthcheckStatus = "unknown" Link to this property const HealthcheckStatusHealthy HealthcheckStatus = "healthy" Link to this property const HealthcheckStatusUnhealthy HealthcheckStatus = "unhealthy" Link to this property const HealthcheckStatusSuspended HealthcheckStatus = "suspended" Link to this property
Link to this property Suspended boolOptional If suspended, no health checks are sent to the origin. Link to this property
TCPConfig TCPConfigurationOptional Parameters specific to TCP health check. Method TCPConfigurationMethodOptional The TCP connection method to use for the health check. Link to this property Port int64Optional Port number to connect to for the health check. Defaults to 80. Link to this property
Link to this property Timeout int64Optional The timeout (in seconds) before marking the health check as failed. Link to this property Type stringOptional 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 Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/healthchecks" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) healthcheck, err := client.Healthchecks.New(context.TODO(), healthchecks.HealthcheckNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), QueryHealthcheck: healthchecks.QueryHealthcheckParam{ Address: cloudflare.F("www.example.com"), Name: cloudflare.F("server-1"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 } ```