API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Diagnostics

DiagnosticsTraceroutes

Traceroute

POST/accounts/{account_id}/diagnostics/traceroute

ModelsExpand Collapse

Traceroute { colos, target }

colos: optional array of { colo, error, hops, 2 more }

colo: optional { city, name }

city: optional string

Source colo city.

name: optional string

Source colo name.

error: optional "" or "Could not gather traceroute data: Code 1" or "Could not gather traceroute data: Code 2" or 2 more

Errors resulting from collecting traceroute from colo to target.

One of the following:

""

"Could not gather traceroute data: Code 1"

"Could not gather traceroute data: Code 2"

"Could not gather traceroute data: Code 3"

"Could not gather traceroute data: Code 4"

hops: optional array of { nodes, packets_lost, packets_sent, packets_ttl }

nodes: optional array of { asn, ip, labels, 6 more }

An array of node objects.

asn: optional string

AS number associated with the node object.

ip: optional string

IP address of the node.

labels: optional array of string

Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.

max_rtt_ms: optional number

Maximum RTT in ms.

mean_rtt_ms: optional number

Mean RTT in ms.

min_rtt_ms: optional number

Minimum RTT in ms.

name: optional string

Host name of the address, this may be the same as the IP address.

packet_count: optional number

Number of packets with a response from this node.

std_dev_rtt_ms: optional number

Standard deviation of the RTTs in ms.

packets_lost: optional number

Number of packets where no response was received.

packets_sent: optional number

Number of packets sent with specified TTL.

packets_ttl: optional number

The time to live (TTL).

target_summary: optional unknown

Aggregated statistics from all hops about the target.

traceroute_time_ms: optional number

Total time of traceroute in ms.

target: optional string

The target hostname, IPv6, or IPv6 address.

DiagnosticsEndpoint Healthchecks

List Endpoint Health Checks

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

Endpoint Health Check

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

Get Endpoint Health Check

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

Delete Endpoint Health Check

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

Update Endpoint Health Check

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

ModelsExpand Collapse

EndpointHealthcheck { check_type, endpoint, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

name: optional string

Optional name associated with this check

EndpointHealthcheckListResponse { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckCreateResponse { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckGetResponse { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckDeleteResponse { errors, messages, success }

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

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

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

success: true

Whether the API call was successful.

EndpointHealthcheckUpdateResponse { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check