--- title: Traceroute --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Diagnostics](https://developers.cloudflare.com/api/resources/diagnostics) [Traceroutes](https://developers.cloudflare.com/api/resources/diagnostics/subresources/traceroutes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Traceroute 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` ##### P ath ParametersExpand Collapse account\_id: string Identifier maxLength32 [Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse targets: array of string maxLength10 [Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20targets%20%3E%20(schema)>) colos: optional array of string If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes. [Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20colos%20%3E%20(schema)>)
options: optional object {max\_ttl, packet\_type, packets\_per\_ttl, 2 more } max\_ttl: optional number Max TTL. maximum64 minimum0 Link to this property
packet\_type: optional "icmp"or "tcp"or "udp"or 2 more Type of packet sent. One of the following: "icmp" Link to this property "tcp" Link to this property "udp" Link to this property "gre" Link to this property "gre+icmp" Link to this property
Link to this property packets\_per\_ttl: optional number Number of packets sent at each TTL. maximum10 minimum0 Link to this property port: optional number 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 wait\_time: optional number Set the time (in seconds) to wait for a response to a probe. maximum5 minimum1 Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20options%20%3E%20(schema)>) ##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional array of Traceroute { colos, target }
colos: optional array of object {colo, error, hops, 2 more }
colo: optional object {city, name } city: optional string Source colo city. Link to this property name: optional string Source colo name. Link to this property
Link to this property
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: "" Link to this property "Could not gather traceroute data: Code 1" Link to this property "Could not gather traceroute data: Code 2" Link to this property "Could not gather traceroute data: Code 3" Link to this property "Could not gather traceroute data: Code 4" Link to this property
Link to this property
hops: optional array of object {nodes, packets\_lost, packets\_sent, packets\_ttl }
nodes: optional array of object {asn, ip, labels, 6 more } An array of node objects. asn: optional string AS number associated with the node object. Link to this property ip: optional string IP address of the node. Link to this property 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. Link to this property max\_rtt\_ms: optional number Maximum RTT in ms. Link to this property mean\_rtt\_ms: optional number Mean RTT in ms. Link to this property min\_rtt\_ms: optional number Minimum RTT in ms. Link to this property name: optional string Host name of the address, this may be the same as the IP address. Link to this property packet\_count: optional number Number of packets with a response from this node. Link to this property std\_dev\_rtt\_ms: optional number Standard deviation of the RTTs in ms. Link to this property
Link to this property packets\_lost: optional number Number of packets where no response was received. Link to this property packets\_sent: optional number Number of packets sent with specified TTL. Link to this property packets\_ttl: optional number The time to live (TTL). Link to this property
Link to this property target\_summary: optional unknown Aggregated statistics from all hops about the target. Link to this property traceroute\_time\_ms: optional number Total time of traceroute in ms. Link to this property
Link to this property target: optional string The target hostname, IPv6, or IPv6 address. Link to this property
[Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Traceroute HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/diagnostics/traceroute \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -d '{ "targets": [ "203.0.113.1", "cloudflare.com" ], "colos": [ "den", "sin" ], "options": { "max_ttl": 15, "packet_type": "icmp" } }' ``` 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" } ] } ```