Skip to content
Cloudflare API
Start here
API Reference

Diagnostics

DiagnosticsTraceroutes

Traceroute
client.Diagnostics.Traceroutes.New(ctx, params) (*SinglePage[Traceroute], error)
POST/accounts/{account_id}/diagnostics/traceroute
ModelsExpand Collapse
type Traceroute struct{…}
Colos []TracerouteColooptional
Colo TracerouteColosColooptional
City stringoptional

Source colo city.

Name stringoptional

Source colo name.

Error TracerouteColosErroroptional

Errors resulting from collecting traceroute from colo to target.

One of the following:
const TracerouteColosErrorEmpty TracerouteColosError = ""
const TracerouteColosErrorCouldNotGatherTracerouteDataCode1 TracerouteColosError = "Could not gather traceroute data: Code 1"
const TracerouteColosErrorCouldNotGatherTracerouteDataCode2 TracerouteColosError = "Could not gather traceroute data: Code 2"
const TracerouteColosErrorCouldNotGatherTracerouteDataCode3 TracerouteColosError = "Could not gather traceroute data: Code 3"
const TracerouteColosErrorCouldNotGatherTracerouteDataCode4 TracerouteColosError = "Could not gather traceroute data: Code 4"
Hops []TracerouteColosHopoptional
Nodes []TracerouteColosHopsNodeoptional

An array of node objects.

ASN stringoptional

AS number associated with the node object.

IP stringoptional

IP address of the node.

Labels []stringoptional

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.

MaxRTTMs float64optional

Maximum RTT in ms.

MeanRTTMs float64optional

Mean RTT in ms.

MinRTTMs float64optional

Minimum RTT in ms.

Name stringoptional

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

PacketCount int64optional

Number of packets with a response from this node.

StdDevRTTMs float64optional

Standard deviation of the RTTs in ms.

PacketsLost int64optional

Number of packets where no response was received.

PacketsSent int64optional

Number of packets sent with specified TTL.

PacketsTTL int64optional

The time to live (TTL).

TargetSummary unknownoptional

Aggregated statistics from all hops about the target.

TracerouteTimeMs int64optional

Total time of traceroute in ms.

Target stringoptional

The target hostname, IPv6, or IPv6 address.

DiagnosticsEndpoint Healthchecks

List Endpoint Health Checks
client.Diagnostics.EndpointHealthchecks.List(ctx, query) (*EndpointHealthcheckListResponse, error)
GET/accounts/{account_id}/diagnostics/endpoint-healthchecks
Endpoint Health Check
client.Diagnostics.EndpointHealthchecks.New(ctx, params) (*EndpointHealthcheckNewResponse, error)
POST/accounts/{account_id}/diagnostics/endpoint-healthchecks
Get Endpoint Health Check
client.Diagnostics.EndpointHealthchecks.Get(ctx, id, query) (*EndpointHealthcheckGetResponse, error)
GET/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
Delete Endpoint Health Check
client.Diagnostics.EndpointHealthchecks.Delete(ctx, id, body) (*EndpointHealthcheckDeleteResponse, error)
DELETE/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
Update Endpoint Health Check
client.Diagnostics.EndpointHealthchecks.Update(ctx, id, params) (*EndpointHealthcheckUpdateResponse, error)
PUT/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
ModelsExpand Collapse
type EndpointHealthcheck struct{…}
CheckType EndpointHealthcheckCheckType

type of check to perform

Endpoint string

the IP address of the host to perform checks against

Name stringoptional

Optional name associated with this check