--- title: Traceroute --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Diagnostics](https://developers.cloudflare.com/api/python/resources/diagnostics) [Traceroutes](https://developers.cloudflare.com/api/python/resources/diagnostics/subresources/traceroutes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Traceroute diagnostics.traceroutes.create(TracerouteCreateParams\*\*kwargs) -> SyncSinglePage\[[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` ##### ParametersExpand Collapse account\_id: str 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)>) targets: Sequence\[str] maxLength10 [Link to this property](<#(resource)%20diagnostics.traceroutes%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20targets%20%3E%20(schema)>) colos: Optional\[Sequence\[str]] 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)%20default%20%3E%20(param)%20colos%20%3E%20(schema)>)
options: Optional\[Options] max\_ttl: Optional\[int] Max TTL. maximum64 minimum0 Link to this property
packet\_type: Optional\[Literal\["icmp", "tcp", "udp", 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\[int] Number of packets sent at each TTL. maximum10 minimum0 Link to this property port: Optional\[int] 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\[int] 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)%20default%20%3E%20(param)%20options%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Traceroute: …
colos: Optional\[List\[Colo]]
colo: Optional\[ColoColo] city: Optional\[str] Source colo city. Link to this property name: Optional\[str] Source colo name. Link to this property
Link to this property
error: Optional\[Literal\["", "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: "" 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\[List\[ColoHop]]
nodes: Optional\[List\[ColoHopNode]] An array of node objects. asn: Optional\[str] AS number associated with the node object. Link to this property ip: Optional\[str] IP address of the node. Link to this property labels: Optional\[List\[str]] 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\[float] Maximum RTT in ms. Link to this property mean\_rtt\_ms: Optional\[float] Mean RTT in ms. Link to this property min\_rtt\_ms: Optional\[float] Minimum RTT in ms. Link to this property name: Optional\[str] Host name of the address, this may be the same as the IP address. Link to this property packet\_count: Optional\[int] Number of packets with a response from this node. Link to this property std\_dev\_rtt\_ms: Optional\[float] Standard deviation of the RTTs in ms. Link to this property
Link to this property packets\_lost: Optional\[int] Number of packets where no response was received. Link to this property packets\_sent: Optional\[int] Number of packets sent with specified TTL. Link to this property packets\_ttl: Optional\[int] The time to live (TTL). Link to this property
Link to this property target\_summary: Optional\[object] Aggregated statistics from all hops about the target. Link to this property traceroute\_time\_ms: Optional\[int] Total time of traceroute in ms. Link to this property
Link to this property target: Optional\[str] 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 Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.diagnostics.traceroutes.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", targets=["203.0.113.1", "cloudflare.com"], ) page = page.result[0] print(page.colos) ``` 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" } ] } ```