Cloudflare API | Healthchecks

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?: string

(format: date-time)

name?: string

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

retries?: number

(default: 2)

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

status?: "unknown" | "healthy" | "unhealthy" | 1 more...

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

suspended?: boolean

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

tcp_config?:

TCPConfiguration

| null

Parameters specific to TCP health check.

timeout?: number

(default: 5)

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

type?: string

(default: "HTTP")

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

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: 'Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY',
});

const healthcheck = await client.healthchecks.get('023e105f4ecef8ad9ca31a8372d0c353', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(healthcheck.id);

200Example

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

client.healthchecks.create(, ):

Healthcheck

post/zones/{zone_id}/healthchecks

Create a new health check.

client.healthchecks.update(, , ):

Healthcheck

put/zones/{zone_id}/healthchecks/{healthcheck_id}

Update a configured health check.

client.healthchecks.edit(, , ):

Healthcheck

patch/zones/{zone_id}/healthchecks/{healthcheck_id}

Patch a configured health check.

client.healthchecks.delete(, , ):

HealthcheckDeleteResponse

delete/zones/{zone_id}/healthchecks/{healthcheck_id}

Delete a health check.

Domain types

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).

Healthcheck{…}

HTTPConfiguration{…}

Parameters specific to an HTTP or HTTPS health check.

QueryHealthcheck{…}

TCPConfiguration{…}

Parameters specific to TCP health check.

Healthchecks