Cloudflare API | Diagnostics › Traceroutes › Traceroute

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Endpoint Healthchecks

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Diagnostics

diagnostics

Endpoint Healthchecks

diagnostics.endpoint-healthchecks

Methods

Endpoint Health Check -> Envelope<{ check_type, endpoint, id, 1 more... }>

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

Create Endpoint Health Check.

Delete Endpoint Health Check -> { errors, messages, success }

delete/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

Delete Endpoint Health Check.

Get Endpoint Health Check -> Envelope<{ check_type, endpoint, id, 1 more... }>

get/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

Get a single Endpoint Health Check.

List Endpoint Health Checks -> Envelope<{ check_type, endpoint, id, 1 more... }>

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

List Endpoint Health Checks.

Update Endpoint Health Check -> Envelope<{ check_type, endpoint, id, 1 more... }>

put/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

Update a Endpoint Health Check.

Domain types

EndpointHealthcheck = { check_type, endpoint, name }

Traceroutes

diagnostics.traceroutes

Methods

Traceroute -> SinglePage<

>

post/accounts/{account_id}/diagnostics/traceroute

Run traceroutes from Cloudflare colos.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Magic Transit Write

path Parameters

account_id: string

(maxLength: 32)

Identifier

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

success: true

Whether the API call was successful.

result: Array<

>

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/diagnostics/traceroute \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "targets": [
            "203.0.113.1",
            "cloudflare.com"
          ],
          "colos": [
            "den",
            "sin"
          ],
          "options": {
            "max_ttl": 15,
            "packet_type": "icmp"
          }
        }'

200Example

{
  "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": [
    {
      "colos": [
        {
          "colo": {
            "city": "Denver, CO, US",
            "name": "den01"
          },
          "error": "",
          "hops": [
            {
              "nodes": [
                {
                  "asn": "AS13335",
                  "ip": "1.1.1.1",
                  "labels": [
                    "string"
                  ],
                  "max_rtt_ms": 0,
                  "mean_rtt_ms": 0,
                  "min_rtt_ms": 0,
                  "name": "one.one.one.one",
                  "packet_count": 3,
                  "std_dev_rtt_ms": 0
                }
              ],
              "packets_lost": 0,
              "packets_sent": 0,
              "packets_ttl": 0
            }
          ],
          "target_summary": {
            "asn": "",
            "ip": "1.1.1.1",
            "max_latency_ms": 0.034,
            "mean_latency_ms": 0.021,
            "min_latency_ms": 0.014,
            "name": "1.1.1.1",
            "packet_count": 3,
            "std_dev_latency_ms": 0.011269427669584647
          },
          "traceroute_time_ms": 0
        }
      ],
      "target": "1.1.1.1"
    }
  ]
}

Domain types

Traceroute = { colos, target }