API Reference

Diagnostics

Endpoint Healthchecks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Endpoint Health Check

diagnostics.endpoint_healthchecks.create(EndpointHealthcheckCreateParams**kwargs) -> EndpointHealthcheckCreateResponse

POST/accounts/{account_id}/diagnostics/endpoint-healthchecks

Create Endpoint Health Check.

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)

Magic Transit Write

ParametersExpand Collapse

account_id: str

Identifier

maxLength32

check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

name: Optional[str]

Optional name associated with this check

ReturnsExpand Collapse

class EndpointHealthcheckCreateResponse: …

check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

id: Optional[str]

UUID.

maxLength36

name: Optional[str]

Optional name associated with this check

Endpoint Health Check

Python

HTTP

TypeScript

Python

Go

Terraform

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
endpoint_healthcheck = client.diagnostics.endpoint_healthchecks.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    check_type="icmp",
    endpoint="203.0.113.1",
)
print(endpoint_healthcheck.id)

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "My Endpoint"
  }
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "My Endpoint"
  }
}