LogoCloudflare API

Healthchecks

healthchecks

Methods

Create Health Check -> Envelope<
Healthcheck
>
post/zones/{zone_id}/healthchecks

Create a new health check.

Delete Health Check -> Envelope<{ id }>
delete/zones/{zone_id}/healthchecks/{healthcheck_id}

Delete a health check.

Patch Health Check -> Envelope<
Healthcheck
>
patch/zones/{zone_id}/healthchecks/{healthcheck_id}

Patch a configured health check.

Health Check Details -> Envelope<
Healthcheck
>
get/zones/{zone_id}/healthchecks/{healthcheck_id}

Fetch a single configured health check.

List Health Checks -> V4PagePaginationArray<
Healthcheck
>
get/zones/{zone_id}/healthchecks

List configured health checks.

Update Health Check -> Envelope<
Healthcheck
>
put/zones/{zone_id}/healthchecks/{healthcheck_id}

Update a configured 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 = { id, address, check_regions, 15 more... }
HTTPConfiguration = { allow_insecure, expected_body, expected_codes, 5 more... }

Parameters specific to an HTTP or HTTPS health check.

QueryHealthcheck = { address, name, check_regions, 10 more... }
TCPConfiguration = { method, port }

Parameters specific to TCP health check.

Healthchecks

Previews

healthchecks.previews

Methods

Create Preview Health Check -> Envelope<
Healthcheck
>
post/zones/{zone_id}/healthchecks/preview

Create a new preview health check.

Delete Preview Health Check -> Envelope<{ id }>
delete/zones/{zone_id}/healthchecks/preview/{healthcheck_id}

Delete a health check.

Health Check Preview Details -> Envelope<
Healthcheck
>
get/zones/{zone_id}/healthchecks/preview/{healthcheck_id}

Fetch a single configured health check preview.