--- title: Traceroute --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Diagnostics](https://developers.cloudflare.com/api/go/resources/diagnostics) [Traceroutes](https://developers.cloudflare.com/api/go/resources/diagnostics/subresources/traceroutes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Traceroute client.Diagnostics.Traceroutes.New(ctx, params) (\*SinglePage\[[Traceroute]()], error) POST/accounts/{account\_id}/diagnostics/traceroute Run traceroutes from Cloudflare colos. ##### 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
params TracerouteNewParams AccountID param.Field\[string] Path param: Identifier maxLength32 Link to this property Targets param.Field\[\[]string] Body param maxLength10 Link to this property Colos param.Field\[\[]string]Optional Body param: If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes. Link to this property
Options param.Field\[TracerouteNewParamsOptions]Optional Body param MaxTTL int64Optional Max TTL. maximum64 minimum0 Link to this property
PacketType TracerouteNewParamsOptionsPacketTypeOptional Type of packet sent. One of the following: const TracerouteNewParamsOptionsPacketTypeIcmp TracerouteNewParamsOptionsPacketType = "icmp" Link to this property const TracerouteNewParamsOptionsPacketTypeTCP TracerouteNewParamsOptionsPacketType = "tcp" Link to this property const TracerouteNewParamsOptionsPacketTypeUdp TracerouteNewParamsOptionsPacketType = "udp" Link to this property const TracerouteNewParamsOptionsPacketTypeGRE TracerouteNewParamsOptionsPacketType = "gre" Link to this property const TracerouteNewParamsOptionsPacketTypeGREIcmp TracerouteNewParamsOptionsPacketType = "gre+icmp" Link to this property
Link to this property PacketsPerTTL int64Optional Number of packets sent at each TTL. maximum10 minimum0 Link to this property Port int64Optional For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol. maximum65535 minimum0 Link to this property WaitTime int64Optional Set the time (in seconds) to wait for a response to a probe. maximum5 minimum1 Link to this property
Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Traceroute struct{…}
Colos \[]TracerouteColoOptional
Colo TracerouteColosColoOptional City stringOptional Source colo city. Link to this property Name stringOptional Source colo name. Link to this property
Link to this property
Error TracerouteColosErrorOptional Errors resulting from collecting traceroute from colo to target. One of the following: const TracerouteColosErrorEmpty TracerouteColosError = "" Link to this property const TracerouteColosErrorCouldNotGatherTracerouteDataCode1 TracerouteColosError = "Could not gather traceroute data: Code 1" Link to this property const TracerouteColosErrorCouldNotGatherTracerouteDataCode2 TracerouteColosError = "Could not gather traceroute data: Code 2" Link to this property const TracerouteColosErrorCouldNotGatherTracerouteDataCode3 TracerouteColosError = "Could not gather traceroute data: Code 3" Link to this property const TracerouteColosErrorCouldNotGatherTracerouteDataCode4 TracerouteColosError = "Could not gather traceroute data: Code 4" Link to this property
Link to this property
Hops \[]TracerouteColosHopOptional
Nodes \[]TracerouteColosHopsNodeOptional An array of node objects. ASN stringOptional AS number associated with the node object. Link to this property IP stringOptional IP address of the node. Link to this property 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. Link to this property MaxRTTMs float64Optional Maximum RTT in ms. Link to this property MeanRTTMs float64Optional Mean RTT in ms. Link to this property MinRTTMs float64Optional Minimum RTT in ms. Link to this property Name stringOptional Host name of the address, this may be the same as the IP address. Link to this property PacketCount int64Optional Number of packets with a response from this node. Link to this property StdDevRTTMs float64Optional Standard deviation of the RTTs in ms. Link to this property
Link to this property PacketsLost int64Optional Number of packets where no response was received. Link to this property PacketsSent int64Optional Number of packets sent with specified TTL. Link to this property PacketsTTL int64Optional The time to live (TTL). Link to this property
Link to this property TargetSummary unknownOptional Aggregated statistics from all hops about the target. Link to this property TracerouteTimeMs int64Optional Total time of traceroute in ms. Link to this property
Link to this property Target stringOptional The target hostname, IPv6, or IPv6 address. Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(model)%20traceroute%20%3E%20(schema)>) ### Traceroute Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/diagnostics" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Diagnostics.Traceroutes.New(context.TODO(), diagnostics.TracerouteNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Targets: cloudflare.F([]string{"203.0.113.1", "cloudflare.com"}), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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": [ { "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" } ] } ``` ##### 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": [ { "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" } ] } ```