Health Check Details

healthchecks.get(, ) -> Healthcheck

GET/zones/{zone_id}/healthchecks/{healthcheck_id}

Fetch a single configured 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 WriteHealth Checks Read

ParametersExpand Collapse

zone_id: str

Identifier

maxLength32

healthcheck_id: str

Identifier

maxLength32

ReturnsExpand Collapse

class Healthcheck: …

id: Optional[str]

Identifier

maxLength32

address: Optional[str]

The hostname or IP address of the origin server to run health checks on.

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"

"ENAM"

"WEU"

"EEU"

"NSAM"

"SSAM"

"OC"

"ME"

"NAF"

"SAF"

"IN"

"SEAS"

"NEAS"

"ALL_REGIONS"

consecutive_fails: Optional[int]

The number of consecutive fails required from a health check before changing the health to unhealthy.

consecutive_successes: Optional[int]

The number of consecutive successes required from a health check before changing the health to healthy.

created_on: Optional[datetime]

formatdate-time

description: Optional[str]

A human-readable description of the health check.

failure_reason: Optional[str]

The current failure reason if status is unhealthy.

http_config: Optional[HTTPConfiguration]

Parameters specific to an HTTP or HTTPS health check.

allow_insecure: Optional[bool]

Do not validate the certificate when the health check uses HTTPS.

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.

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.

follow_redirects: Optional[bool]

Follow redirects if the origin returns a 3xx status code.

method: Optional[Literal["GET", "HEAD"]]

The HTTP method to use for the health check.

One of the following:

"GET"

"HEAD"

path: Optional[str]

The endpoint path to health check against.

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.

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.

modified_on: Optional[datetime]

formatdate-time

name: Optional[str]

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

retries: Optional[int]

The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

status: Optional[Literal["unknown", "healthy", "unhealthy", "suspended"]]

The current status of the origin server according to the health check.

One of the following:

"unknown"

"healthy"

"unhealthy"

"suspended"

suspended: Optional[bool]

If suspended, no health checks are sent to the origin.

tcp_config: Optional[TCPConfiguration]

Parameters specific to TCP health check.

method: Optional[Literal["connection_established"]]

The TCP connection method to use for the health check.

port: Optional[int]

Port number to connect to for the health check. Defaults to 80.

timeout: Optional[int]

The timeout (in seconds) before marking the health check as failed.

type: Optional[str]

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

Health Check Details

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.get(
    healthcheck_id="023e105f4ecef8ad9ca31a8372d0c353",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(healthcheck.id)

{
  "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

{
  "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
}