List Health Checks

GET/zones/{zone_id}/smart_shield/healthchecks

List configured health checks.

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

Path ParametersExpand Collapse

zone_id: string

Identifier.

maxLength32

Query ParametersExpand Collapse

page: optional number

Page number of paginated results.

minimum1

per_page: optional number

Maximum number of results per page. Must be a multiple of 5.

maximum1000

minimum5

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: unknown or array of unknown or string

One of the following:

unknown

array of unknown

string

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

count: optional number

Total number of results for the requested service

page: optional number

Current page within paginated list of results

per_page: optional number

Number of results per page of results

total_count: optional number

Total results available without any search parameters

List Health Checks

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/smart_shield/healthchecks \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [],
  "messages": [],
  "result": [],
  "success": true
}

{
  "errors": [
    {
      "code": 1000,
      "message": "An error occurred."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": [],
  "success": true
}

{
  "errors": [
    {
      "code": 1000,
      "message": "An error occurred."
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}