endpoint_healthchecks

Creates, updates, deletes, gets or lists an endpoint_healthchecks resource.

Overview

Name	endpoint_healthchecks
Type	Resource
Id	cloudflare.diagnostics.endpoint_healthchecks

Fields

The following fields are returned by SELECT queries:

get

Endpoint Health Checks response.

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	Optional name associated with this check (example: My Endpoint)
check_type	string	type of check to perform (icmp) (default: icmp, example: icmp)
endpoint	string	the IP address of the host to perform checks against (example: 203.0.113.1)

list

Endpoint Health Checks for account.

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	Optional name associated with this check (example: My Endpoint)
check_type	string	type of check to perform (icmp) (default: icmp, example: icmp)
endpoint	string	the IP address of the host to perform checks against (example: 203.0.113.1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, id		Get a single Endpoint Health Check.
list	select	account_id		List Endpoint Health Checks.
create	insert	account_id, check_type, endpoint		Create Endpoint Health Check.
update	replace	account_id, id, check_type, endpoint		Update a Endpoint Health Check.
delete	delete	account_id, id		Delete Endpoint 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
account_id	string	The Cloudflare account ID.
id	string	Resource ID.

SELECT examples

get

Get a single Endpoint Health Check.

SELECT
id,
name,
check_type,
endpoint
FROM cloudflare.diagnostics.endpoint_healthchecks
WHERE account_id = '{{ account_id }}' -- required
AND id = '{{ id }}' -- required
;

list

List Endpoint Health Checks.

SELECT
id,
name,
check_type,
endpoint
FROM cloudflare.diagnostics.endpoint_healthchecks
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create Endpoint Health Check.

INSERT INTO cloudflare.diagnostics.endpoint_healthchecks (
check_type,
endpoint,
name,
account_id
)
SELECT 
'{{ check_type }}' /* required */,
'{{ endpoint }}' /* required */,
'{{ name }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: endpoint_healthchecks
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the endpoint_healthchecks resource.
  - name: check_type
    value: "{{ check_type }}"
    description: |
      type of check to perform
    valid_values: ['icmp']
    default: icmp
  - name: endpoint
    value: "{{ endpoint }}"
    description: |
      the IP address of the host to perform checks against
  - name: name
    value: "{{ name }}"
    description: |
      Optional name associated with this check

REPLACE examples

update

Update a Endpoint Health Check.

REPLACE cloudflare.diagnostics.endpoint_healthchecks
SET 
check_type = '{{ check_type }}',
endpoint = '{{ endpoint }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required
AND check_type = '{{ check_type }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete Endpoint Health Check.

DELETE FROM cloudflare.diagnostics.endpoint_healthchecks
WHERE account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required
;