traceroute_tests

Creates, updates, deletes, gets or lists a traceroute_tests resource.

Overview

Name	traceroute_tests
Type	Resource
Id	cloudflare.zero_trust.traceroute_tests

Fields

The following fields are returned by SELECT queries:

get

DEX traceroute test details response

Name	Datatype	Description
name	string	The name of the Traceroute synthetic application test (example: Atlassian Sign In Page)
host	string	The host of the Traceroute synthetic application test (example: 1.1.1.1)
interval	string	The interval at which the Traceroute synthetic application test is set to run. (example: 0h5m0s)
kind	string	(traceroute)
target_policies	array
targeted	boolean
tracerouteStats	object
tracerouteStatsByColo	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, test_id	deviceId, from, to, interval, colo	Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
test_id	string	Unique identifier for a specific test
colo	string	Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
deviceId	array	Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
from	string	Start time for aggregate metrics in ISO ms
interval	string	Time interval for aggregate time slots.
to	string	End time for aggregate metrics in ISO ms

SELECT examples

get

Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.

SELECT
name,
host,
interval,
kind,
target_policies,
targeted,
tracerouteStats,
tracerouteStatsByColo
FROM cloudflare.zero_trust.traceroute_tests
WHERE account_id = '{{ account_id }}' -- required
AND test_id = '{{ test_id }}' -- required
AND deviceId = '{{ deviceId }}'
AND from = '{{ from }}'
AND to = '{{ to }}'
AND interval = '{{ interval }}'
AND colo = '{{ colo }}'
;