healthchecks

Creates, updates, deletes, gets or lists a healthchecks resource.

Overview

Name	`healthchecks`
Type	Resource
Id	`cloudflare.zones.healthchecks`

Fields

The following fields are returned by SELECT queries:

get
list

Health Check Details response.

Name	Datatype	Description
`id`	`string`	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
`name`	`string`	A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. (example: server-1)
`address`	`string`	The hostname or IP address of the origin server to run health checks on. (example: www.example.com)
`check_regions`	`array`	A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
`consecutive_fails`	`integer`	The number of consecutive fails required from a health check before changing the health to unhealthy.
`consecutive_successes`	`integer`	The number of consecutive successes required from a health check before changing the health to healthy.
`created_on`	`string (date-time)`	(example: 2014-01-01T05:20:00.12345Z)
`description`	`string`	A human-readable description of the health check. (example: Health check for www.example.com)
`failure_reason`	`string`	The current failure reason if status is unhealthy. (example: )
`http_config`	`object`	Parameters specific to an HTTP or HTTPS health check.
`interval`	`integer`	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 (date-time)`	(example: 2014-01-01T05:20:00.12345Z)
`retries`	`integer`	The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
`status`	`string`	The current status of the origin server according to the health check. (unknown, healthy, unhealthy, suspended) (example: healthy)
`suspended`	`boolean`	If suspended, no health checks are sent to the origin.
`tcp_config`	`object`	Parameters specific to TCP health check.
`timeout`	`integer`	The timeout (in seconds) before marking the health check as failed.
`type`	`string`	The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'. (default: HTTP, example: HTTPS)

List Health Checks response

Name	Datatype	Description
`id`	`string`	Identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
`name`	`string`	A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. (example: server-1)
`address`	`string`	The hostname or IP address of the origin server to run health checks on. (example: www.example.com)
`check_regions`	`array`	A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
`consecutive_fails`	`integer`	The number of consecutive fails required from a health check before changing the health to unhealthy.
`consecutive_successes`	`integer`	The number of consecutive successes required from a health check before changing the health to healthy.
`created_on`	`string (date-time)`	(example: 2014-01-01T05:20:00.12345Z)
`description`	`string`	A human-readable description of the health check. (example: Health check for www.example.com)
`failure_reason`	`string`	The current failure reason if status is unhealthy. (example: )
`http_config`	`object`	Parameters specific to an HTTP or HTTPS health check.
`interval`	`integer`	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 (date-time)`	(example: 2014-01-01T05:20:00.12345Z)
`retries`	`integer`	The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
`status`	`string`	The current status of the origin server according to the health check. (unknown, healthy, unhealthy, suspended) (example: healthy)
`suspended`	`boolean`	If suspended, no health checks are sent to the origin.
`tcp_config`	`object`	Parameters specific to TCP health check.
`timeout`	`integer`	The timeout (in seconds) before marking the health check as failed.
`type`	`string`	The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'. (default: HTTP, example: HTTPS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`healthcheck_id`, `zone_id`		Fetch a single configured health check.
`list`	`select`	`zone_id`	`page`, `per_page`	List configured health checks.
`smart_shield_create_health_check`	`insert`	`zone_id`, `name`, `address`		Create a new health check.
`smart_shield_patch_health_check`	`update`	`healthcheck_id`, `zone_id`, `name`, `address`		Patch a configured health check.
`smart_shield_update_health_check`	`replace`	`healthcheck_id`, `zone_id`, `success`, `errors`, `messages`, `result`		Update a configured health check.
`smart_shield_delete_health_check`	`delete`	`healthcheck_id`, `zone_id`		Delete a health check.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`healthcheck_id`	`string`
`zone_id`	`string`	The Cloudflare zone ID.
`page`	`number`	Page number of paginated results.
`per_page`	`number`	Maximum number of results per page. Must be a multiple of 5.

`SELECT` examples

get
list

Fetch a single configured health check.

SELECT
id,
name,
address,
check_regions,
consecutive_fails,
consecutive_successes,
created_on,
description,
failure_reason,
http_config,
interval,
modified_on,
retries,
status,
suspended,
tcp_config,
timeout,
type
FROM cloudflare.zones.healthchecks
WHERE healthcheck_id = '{{ healthcheck_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;

List configured health checks.

SELECT
id,
name,
address,
check_regions,
consecutive_fails,
consecutive_successes,
created_on,
description,
failure_reason,
http_config,
interval,
modified_on,
retries,
status,
suspended,
tcp_config,
timeout,
type
FROM cloudflare.zones.healthchecks
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

`INSERT` examples

smart_shield_create_health_check
Manifest

Create a new health check.

INSERT INTO cloudflare.zones.healthchecks (
address,
check_regions,
consecutive_fails,
consecutive_successes,
description,
http_config,
interval,
name,
retries,
suspended,
tcp_config,
timeout,
type,
zone_id
)
SELECT 
'{{ address }}' /* required */,
'{{ check_regions }}',
{{ consecutive_fails }},
{{ consecutive_successes }},
'{{ description }}',
'{{ http_config }}',
{{ interval }},
'{{ name }}' /* required */,
{{ retries }},
{{ suspended }},
'{{ tcp_config }}',
{{ timeout }},
'{{ type }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

# Description fields are for documentation purposes
- name: healthchecks
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the healthchecks resource.
  - name: address
    value: "{{ address }}"
    description: |
      The hostname or IP address of the origin server to run health checks on.
  - name: check_regions
    value:
      - "{{ check_regions }}"
    description: |
      A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
  - name: consecutive_fails
    value: {{ consecutive_fails }}
    description: |
      The number of consecutive fails required from a health check before changing the health to unhealthy.
    default: 1
  - name: consecutive_successes
    value: {{ consecutive_successes }}
    description: |
      The number of consecutive successes required from a health check before changing the health to healthy.
    default: 1
  - name: description
    value: "{{ description }}"
    description: |
      A human-readable description of the health check.
  - name: http_config
    description: |
      Parameters specific to an HTTP or HTTPS health check.
    value:
      allow_insecure: {{ allow_insecure }}
      expected_body: "{{ expected_body }}"
      expected_codes:
        - "{{ expected_codes }}"
      follow_redirects: {{ follow_redirects }}
      header: "{{ header }}"
      method: "{{ method }}"
      path: "{{ path }}"
      port: {{ port }}
  - name: interval
    value: {{ interval }}
    description: |
      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.
    default: 60
  - name: name
    value: "{{ name }}"
    description: |
      A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
  - name: retries
    value: {{ retries }}
    description: |
      The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    default: 2
  - name: suspended
    value: {{ suspended }}
    description: |
      If suspended, no health checks are sent to the origin.
    default: false
  - name: tcp_config
    description: |
      Parameters specific to TCP health check.
    value:
      method: "{{ method }}"
      port: {{ port }}
  - name: timeout
    value: {{ timeout }}
    description: |
      The timeout (in seconds) before marking the health check as failed.
    default: 5
  - name: type
    value: "{{ type }}"
    description: |
      The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
    default: HTTP

`UPDATE` examples

smart_shield_patch_health_check

Patch a configured health check.

UPDATE cloudflare.zones.healthchecks
SET 
address = '{{ address }}',
check_regions = '{{ check_regions }}',
consecutive_fails = {{ consecutive_fails }},
consecutive_successes = {{ consecutive_successes }},
description = '{{ description }}',
http_config = '{{ http_config }}',
interval = {{ interval }},
name = '{{ name }}',
retries = {{ retries }},
suspended = {{ suspended }},
tcp_config = '{{ tcp_config }}',
timeout = {{ timeout }},
type = '{{ type }}'
WHERE 
healthcheck_id = '{{ healthcheck_id }}' --required
AND zone_id = '{{ zone_id }}' --required
AND name = '{{ name }}' --required
AND address = '{{ address }}' --required
RETURNING
errors,
messages,
result,
success;

`REPLACE` examples

smart_shield_update_health_check

Update a configured health check.

REPLACE cloudflare.zones.healthchecks
SET 
errors = '{{ errors }}',
messages = '{{ messages }}',
result = '{{ result }}',
success = {{ success }}
WHERE 
healthcheck_id = '{{ healthcheck_id }}' --required
AND zone_id = '{{ zone_id }}' --required
AND success = {{ success }} --required
AND errors = '{{ errors }}' --required
AND messages = '{{ messages }}' --required
AND result = '{{ result }}' --required
RETURNING
errors,
messages,
result,
success;

`DELETE` examples

smart_shield_delete_health_check

Delete a health check.

DELETE FROM cloudflare.zones.healthchecks
WHERE healthcheck_id = '{{ healthcheck_id }}' --required
AND zone_id = '{{ zone_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​