API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Diagnostics

DiagnosticsTraceroutes

Traceroute

client.diagnostics.traceroutes.create(TracerouteCreateParams { account_id, targets, colos, options } params, RequestOptionsoptions?): SinglePage<Traceroute { colos, target } >

POST/accounts/{account_id}/diagnostics/traceroute

ModelsExpand Collapse

Traceroute { colos, target }

colos?: Array<Colo>

colo?: Colo { city, name }

city?: string

Source colo city.

name?: string

Source colo name.

error?: "" | "Could not gather traceroute data: Code 1" | "Could not gather traceroute data: Code 2" | 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?: Array<Hop>

nodes?: Array<Node>

An array of node objects.

asn?: string

AS number associated with the node object.

ip?: string

IP address of the node.

labels?: Array<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?: number

Maximum RTT in ms.

mean_rtt_ms?: number

Mean RTT in ms.

min_rtt_ms?: number

Minimum RTT in ms.

name?: string

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

packet_count?: number

Number of packets with a response from this node.

std_dev_rtt_ms?: number

Standard deviation of the RTTs in ms.

packets_lost?: number

Number of packets where no response was received.

packets_sent?: number

Number of packets sent with specified TTL.

packets_ttl?: number

The time to live (TTL).

target_summary?: unknown

Aggregated statistics from all hops about the target.

traceroute_time_ms?: number

Total time of traceroute in ms.

target?: string

The target hostname, IPv6, or IPv6 address.

DiagnosticsEndpoint Healthchecks

List Endpoint Health Checks

client.diagnostics.endpointHealthchecks.list(EndpointHealthcheckListParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckListResponse { check_type, endpoint, id, name }

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

Endpoint Health Check

client.diagnostics.endpointHealthchecks.create(EndpointHealthcheckCreateParams { account_id, check_type, endpoint, name } params, RequestOptionsoptions?): EndpointHealthcheckCreateResponse { check_type, endpoint, id, name }

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

Get Endpoint Health Check

client.diagnostics.endpointHealthchecks.get(stringid, EndpointHealthcheckGetParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckGetResponse { check_type, endpoint, id, name }

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

Delete Endpoint Health Check

client.diagnostics.endpointHealthchecks.delete(stringid, EndpointHealthcheckDeleteParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckDeleteResponse { errors, messages, success }

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

Update Endpoint Health Check

client.diagnostics.endpointHealthchecks.update(stringid, EndpointHealthcheckUpdateParams { account_id, check_type, endpoint, name } params, RequestOptionsoptions?): EndpointHealthcheckUpdateResponse { check_type, endpoint, id, name }

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?: 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?: string

UUID.

maxLength36

name?: 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?: string

UUID.

maxLength36

name?: 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check

EndpointHealthcheckDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check