--- title: DEX --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Zero Trust](https://developers.cloudflare.com/api/go/resources/zero_trust) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # DEX ##### ModelsExpand Collapse

type DigitalExperienceMonitor struct{…}

ID string API Resource UUID tag. maxLength36 Link to this property Default bool Whether the policy is the default for the account. Link to this property Name string Link to this property

[Link to this property](<#(resource)%20zero_trust.dex%20%3E%20(model)%20digital_experience_monitor%20%3E%20(schema)>)

type NetworkPath struct{…}

Slots \[]NetworkPathSlot

ID string API Resource UUID tag. maxLength36 Link to this property ClientToAppRTTMs int64 Round trip time in ms of the client to app mile Link to this property ClientToCfEgressRTTMs int64 Round trip time in ms of the client to Cloudflare egress mile Link to this property ClientToCfIngressRTTMs int64 Round trip time in ms of the client to Cloudflare ingress mile Link to this property Timestamp string Link to this property ClientToISPRTTMs int64Optional Round trip time in ms of the client to ISP mile Link to this property

Link to this property

Sampling NetworkPathSamplingOptional Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.

Unit NetworkPathSamplingUnit Link to this property Value int64 Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex%20%3E%20(model)%20network_path%20%3E%20(schema)>)

type NetworkPathResponse struct{…}

ID string API Resource UUID tag. maxLength36 Link to this property DeviceName stringOptional Name of the device that ran the test. Link to this property Interval stringOptional The interval at which the Traceroute synthetic application test is set to run. Link to this property Kind NetworkPathResponseKindOptional Link to this property Name stringOptional Link to this property NetworkPath NetworkPathOptional Link to this property URL stringOptional The host of the Traceroute synthetic application test. Link to this property

[Link to this property](<#(resource)%20zero_trust.dex%20%3E%20(model)%20network_path_response%20%3E%20(schema)>)

type Percentiles struct{…}

P50 float64Optional p50 observed in the time period. Link to this property P90 float64Optional p90 observed in the time period. Link to this property P95 float64Optional p95 observed in the time period. Link to this property P99 float64Optional p99 observed in the time period. Link to this property

[Link to this property](<#(resource)%20zero_trust.dex%20%3E%20(model)%20percentiles%20%3E%20(schema)>) #### DEXWARP Change Events ##### [List WARP change events.](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/warp_change_events/methods/get) client.ZeroTrust.DEX.WARPChangeEvents.Get(ctx, params) (\*\[] [DexwarpChangeEventGetResponse](), error) GET/accounts/{account\_id}/dex/warp-change-events #### DEXCommands ##### [List account commands](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/commands/methods/list) client.ZeroTrust.DEX.Commands.List(ctx, params) (\*V4PagePagination\[[DEXCommandListResponse]()], error) GET/accounts/{account\_id}/dex/commands ##### [Create account commands](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/commands/methods/create) client.ZeroTrust.DEX.Commands.New(ctx, params) (\*[DEXCommandNewResponse](), error) POST/accounts/{account\_id}/dex/commands #### DEXCommandsDevices ##### [List devices eligible for remote captures](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/commands/subresources/devices/methods/list) client.ZeroTrust.DEX.Commands.Devices.List(ctx, params) (\*V4PagePagination\[[DEXCommandDeviceListResponse]()], error) GET/accounts/{account\_id}/dex/commands/devices #### DEXCommandsDownloads ##### [Download command output file](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/commands/subresources/downloads/methods/get) client.ZeroTrust.DEX.Commands.Downloads.Get(ctx, commandID, filename, query) (\*Response, error) GET/accounts/{account\_id}/dex/commands/{command\_id}/downloads/{filename} #### DEXCommandsQuota ##### [Returns account commands usage, quota, and reset time](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/commands/subresources/quota/methods/get) client.ZeroTrust.DEX.Commands.Quota.Get(ctx, query) (\*[DEXCommandQuotaGetResponse](), error) GET/accounts/{account\_id}/dex/commands/quota #### DEXColos ##### [List Cloudflare colos](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/colos/methods/list) client.ZeroTrust.DEX.Colos.List(ctx, params) (\*SinglePage\[[DEXColoListResponse]()], error) GET/accounts/{account\_id}/dex/colos #### DEXFleet Status ##### [Get live aggregate device details by dimension](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/live) client.ZeroTrust.DEX.FleetStatus.Live(ctx, params) (\*[DEXFleetStatusLiveResponse](), error) GET/accounts/{account\_id}/dex/fleet-status/live ##### [Get over time aggregate details for devices by dimension](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/over_time) client.ZeroTrust.DEX.FleetStatus.OverTime(ctx, params) (\*[DEXFleetStatusOverTimeResponse](), error) GET/accounts/{account\_id}/dex/fleet-status/over-time ##### ModelsExpand Collapse

type LiveStat struct{…}

UniqueDevicesTotal float64Optional Number of unique devices Link to this property Value stringOptional Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.fleet_status%20%3E%20(model)%20live_stat%20%3E%20(schema)>) #### DEXFleet StatusDevices ##### [List details of devices using WARP.](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/fleet_status/subresources/devices/methods/list) client.ZeroTrust.DEX.FleetStatus.Devices.List(ctx, params) (\*V4PagePaginationArray\[[DEXFleetStatusDeviceListResponse]()], error) GET/accounts/{account\_id}/dex/fleet-status/devices #### DEXHTTP Tests ##### [Get details and aggregate metrics for an http test](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/http_tests/methods/get) client.ZeroTrust.DEX.HTTPTests.Get(ctx, testID, params) (\*[HTTPDetails](), error) GET/accounts/{account\_id}/dex/http-tests/{test\_id} ##### ModelsExpand Collapse

type HTTPDetails struct{…}

Host stringOptional The url of the HTTP synthetic application test. Link to this property

HTTPStats HTTPDetailsHTTPStatsOptional

AvailabilityPct HTTPDetailsHTTPStatsAvailabilityPct

Slots \[]HTTPDetailsHTTPStatsAvailabilityPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property Avg float64Optional average observed in the time period. formatfloat Link to this property Max float64Optional highest observed in the time period. formatfloat Link to this property Min float64Optional lowest observed in the time period. formatfloat Link to this property

Link to this property DNSResponseTimeMs TestStatOverTime Link to this property

HTTPStatusCode \[]HTTPDetailsHTTPStatsHTTPStatusCode

Status200 int64 Link to this property Status300 int64 Link to this property Status400 int64 Link to this property Status500 int64 Link to this property Timestamp string Link to this property

Link to this property ResourceFetchTimeMs TestStatOverTime Link to this property ServerResponseTimeMs TestStatOverTime Link to this property UniqueDevicesTotal int64 Count of unique devices that have run this test in the given time period. Link to this property

Link to this property

HTTPStatsByColo \[]HTTPDetailsHTTPStatsByColoOptional

AvailabilityPct HTTPDetailsHTTPStatsByColoAvailabilityPct

Slots \[]HTTPDetailsHTTPStatsByColoAvailabilityPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property Colo string Link to this property DNSResponseTimeMs TestStatOverTime Link to this property

HTTPStatusCode \[]HTTPDetailsHTTPStatsByColoHTTPStatusCode

Status200 int64 Link to this property Status300 int64 Link to this property Status400 int64 Link to this property Status500 int64 Link to this property Timestamp string Link to this property

Link to this property Interval stringOptional The interval at which the HTTP synthetic application test is set to run. Link to this property Kind HTTPDetailsKindOptional Link to this property Method stringOptional The HTTP method to use when running the test. Link to this property Name stringOptional The name of the HTTP synthetic application test. Link to this property

TargetPolicies \[]DigitalExperienceMonitorOptional

ID string API Resource UUID tag. maxLength36 Link to this property Default bool Whether the policy is the default for the account. Link to this property Name string Link to this property

Link to this property Targeted boolOptional Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.http_tests%20%3E%20(model)%20http_details%20%3E%20(schema)>) #### DEXHTTP TestsPercentiles ##### [Get percentiles for an http test](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/http_tests/subresources/percentiles/methods/get) client.ZeroTrust.DEX.HTTPTests.Percentiles.Get(ctx, testID, params) (\*[HTTPDetailsPercentiles](), error) GET/accounts/{account\_id}/dex/http-tests/{test\_id}/percentiles ##### ModelsExpand Collapse

type HTTPDetailsPercentiles struct{…}

DNSResponseTimeMs PercentilesOptional Link to this property ResourceFetchTimeMs PercentilesOptional Link to this property ServerResponseTimeMs PercentilesOptional Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.http_tests.percentiles%20%3E%20(model)%20http_details_percentiles%20%3E%20(schema)>)

type TestStatOverTime struct{…}

Slots \[]TestStatOverTimeSlot

Timestamp string Link to this property Value int64 Link to this property

Link to this property Avg int64Optional average observed in the time period. Link to this property Max int64Optional highest observed in the time period. Link to this property Min int64Optional lowest observed in the time period. Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.http_tests.percentiles%20%3E%20(model)%20test_stat_over_time%20%3E%20(schema)>) #### DEXTests ##### [List DEX test analytics](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/tests/methods/list) client.ZeroTrust.DEX.Tests.List(ctx, params) (\*V4PagePagination\[[Tests]()], error) GET/accounts/{account\_id}/dex/tests/overview ##### ModelsExpand Collapse

type AggregateTimePeriod struct{…}

Units AggregateTimePeriodUnits

One of the following: const AggregateTimePeriodUnitsHours AggregateTimePeriodUnits = "hours" Link to this property const AggregateTimePeriodUnitsDays AggregateTimePeriodUnits = "days" Link to this property const AggregateTimePeriodUnitsTestRuns AggregateTimePeriodUnits = "testRuns" Link to this property

Link to this property Value int64 Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(model)%20aggregate_time_period%20%3E%20(schema)>)

type Tests struct{…}

OverviewMetrics TestsOverviewMetrics

TestsTotal int64 number of tests. Link to this property AvgHTTPAvailabilityPct float64Optional percentage availability for all HTTP test results in response. formatfloat Link to this property AvgTracerouteAvailabilityPct float64Optional percentage availability for all traceroutes results in response. formatfloat Link to this property

Link to this property

Tests \[]TestsTest array of test results objects.

ID string API Resource UUID tag. maxLength36 Link to this property Created string date the test was created. Link to this property Description string the test description defined during configuration Link to this property Enabled bool if true, then the test will run on targeted devices. Else, the test will not run. Link to this property Host string Link to this property Interval string The interval at which the synthetic application test is set to run. Link to this property

Kind TestsTestsKind test type, http or traceroute

One of the following: const TestsTestsKindHTTP TestsTestsKind = "http" Link to this property const TestsTestsKindTraceroute TestsTestsKind = "traceroute" Link to this property

Link to this property Name string name given to this test Link to this property Updated string Link to this property

HTTPResults TestsTestsHTTPResultsOptional

ResourceFetchTime TestsTestsHTTPResultsResourceFetchTime

History \[]TestsTestsHTTPResultsResourceFetchTimeHistory

TimePeriod AggregateTimePeriod Link to this property AvgMs int64Optional Link to this property DeltaPct float64Optional formatfloat Link to this property

Link to this property AvgMs int64Optional Link to this property

OverTime TestsTestsHTTPResultsResourceFetchTimeOverTimeOptional

TimePeriod AggregateTimePeriod Link to this property

Values \[]TestsTestsHTTPResultsResourceFetchTimeOverTimeValue

AvgMs int64 Link to this property Timestamp string Link to this property

Link to this property

HTTPResultsByColo \[]TestsTestsHTTPResultsByColoOptional

Colo string Cloudflare colo Link to this property

ResourceFetchTime TestsTestsHTTPResultsByColoResourceFetchTime

History \[]TestsTestsHTTPResultsByColoResourceFetchTimeHistory

TimePeriod AggregateTimePeriod Link to this property AvgMs int64Optional Link to this property DeltaPct float64Optional formatfloat Link to this property

Link to this property AvgMs int64Optional Link to this property

OverTime TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeOptional

TimePeriod AggregateTimePeriod Link to this property

Values \[]TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue

AvgMs int64 Link to this property Timestamp string Link to this property

Link to this property

Link to this property Method stringOptional for HTTP, the method to use when running the test Link to this property

TargetPolicies \[]DigitalExperienceMonitorOptional

ID string API Resource UUID tag. maxLength36 Link to this property Default bool Whether the policy is the default for the account. Link to this property Name string Link to this property

Link to this property Targeted boolOptional Link to this property

TracerouteResults TestsTestsTracerouteResultsOptional

RoundTripTime TestsTestsTracerouteResultsRoundTripTime

History \[]TestsTestsTracerouteResultsRoundTripTimeHistory

TimePeriod AggregateTimePeriod Link to this property AvgMs int64Optional Link to this property DeltaPct float64Optional formatfloat Link to this property

Link to this property AvgMs int64Optional Link to this property

OverTime TestsTestsTracerouteResultsRoundTripTimeOverTimeOptional

TimePeriod AggregateTimePeriod Link to this property

Values \[]TestsTestsTracerouteResultsRoundTripTimeOverTimeValue

AvgMs int64 Link to this property Timestamp string Link to this property

Link to this property

TracerouteResultsByColo \[]TestsTestsTracerouteResultsByColoOptional

Colo string Cloudflare colo Link to this property

RoundTripTime TestsTestsTracerouteResultsByColoRoundTripTime

History \[]TestsTestsTracerouteResultsByColoRoundTripTimeHistory

TimePeriod AggregateTimePeriod Link to this property AvgMs int64Optional Link to this property DeltaPct float64Optional formatfloat Link to this property

Link to this property AvgMs int64Optional Link to this property

OverTime TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeOptional

TimePeriod AggregateTimePeriod Link to this property

Values \[]TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue

AvgMs int64 Link to this property Timestamp string Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(model)%20tests%20%3E%20(schema)>) #### DEXTestsUnique Devices ##### [Get count of devices targeted](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/tests/subresources/unique_devices/methods/list) client.ZeroTrust.DEX.Tests.UniqueDevices.List(ctx, params) (\*[UniqueDevices](), error) GET/accounts/{account\_id}/dex/tests/unique-devices ##### ModelsExpand Collapse

type UniqueDevices struct{…}

UniqueDevicesTotal int64 total number of unique devices Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.tests.unique_devices%20%3E%20(model)%20unique_devices%20%3E%20(schema)>) #### DEXTraceroute Test Results #### DEXTraceroute Test ResultsNetwork Path ##### [Get details for a specific traceroute test run](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/traceroute_test_results/subresources/network_path/methods/get) client.ZeroTrust.DEX.TracerouteTestResults.NetworkPath.Get(ctx, testResultID, query) (\*[DEXTracerouteTestResultNetworkPathGetResponse](), error) GET/accounts/{account\_id}/dex/traceroute-test-results/{test\_result\_id}/network-path #### DEXTraceroute Tests ##### [Get details and aggregate metrics for a traceroute test](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/get) client.ZeroTrust.DEX.TracerouteTests.Get(ctx, testID, params) (\*[Traceroute](), error) GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id} ##### [Get percentiles for a traceroute test](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/percentiles) client.ZeroTrust.DEX.TracerouteTests.Percentiles(ctx, testID, params) (\*[DEXTracerouteTestPercentilesResponse](), error) GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/percentiles ##### [Get network path breakdown for a traceroute test](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/network_path) client.ZeroTrust.DEX.TracerouteTests.NetworkPath(ctx, testID, params) (\*[NetworkPathResponse](), error) GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/network-path ##### ModelsExpand Collapse

type Traceroute struct{…}

Host string The host of the Traceroute synthetic application test. Link to this property Interval string The interval at which the Traceroute synthetic application test is set to run. Link to this property Kind TracerouteKind Link to this property Name string The name of the Traceroute synthetic application test. Link to this property

TargetPolicies \[]DigitalExperienceMonitorOptional

ID string API Resource UUID tag. maxLength36 Link to this property Default bool Whether the policy is the default for the account. Link to this property Name string Link to this property

Link to this property Targeted boolOptional Link to this property

TracerouteStats TracerouteTracerouteStatsOptional

AvailabilityPct TracerouteTracerouteStatsAvailabilityPct

Slots \[]TracerouteTracerouteStatsAvailabilityPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property HopsCount TestStatOverTime Link to this property

PacketLossPct TracerouteTracerouteStatsPacketLossPct

Slots \[]TracerouteTracerouteStatsPacketLossPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property RoundTripTimeMs TestStatOverTime Link to this property UniqueDevicesTotal int64 Count of unique devices that have run this test in the given time period. Link to this property

Link to this property

TracerouteStatsByColo \[]TracerouteTracerouteStatsByColoOptional

AvailabilityPct TracerouteTracerouteStatsByColoAvailabilityPct

Slots \[]TracerouteTracerouteStatsByColoAvailabilityPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property Colo string Link to this property HopsCount TestStatOverTime Link to this property

PacketLossPct TracerouteTracerouteStatsByColoPacketLossPct

Slots \[]TracerouteTracerouteStatsByColoPacketLossPctSlot

Timestamp string Link to this property Value float64 formatfloat Link to this property

Link to this property RoundTripTimeMs TestStatOverTime Link to this property UniqueDevicesTotal int64 Count of unique devices that have run this test in the given time period. Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.traceroute_tests%20%3E%20(model)%20traceroute%20%3E%20(schema)>) #### DEXRules ##### [Get DEX Rule](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/rules/methods/get) client.ZeroTrust.DEX.Rules.Get(ctx, ruleID, query) (\*[DEXRuleGetResponse](), error) GET/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Delete a DEX Rule](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/rules/methods/delete) client.ZeroTrust.DEX.Rules.Delete(ctx, ruleID, body) (\*bool, error) DELETE/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Update a DEX Rule](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/rules/methods/update) client.ZeroTrust.DEX.Rules.Update(ctx, ruleID, params) (\*[DEXRuleUpdateResponse](), error) PATCH/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Create a DEX Rule](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/rules/methods/create) client.ZeroTrust.DEX.Rules.New(ctx, params) (\*[DEXRuleNewResponse](), error) POST/accounts/{account\_id}/dex/rules ##### [List DEX Rules](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/rules/methods/list) client.ZeroTrust.DEX.Rules.List(ctx, params) (\*V4PagePagination\[[DEXRuleListResponse]()], error) GET/accounts/{account\_id}/dex/rules #### DEXDevices #### DEXDevicesISPs ##### [List device ISPs](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/dex/subresources/devices/subresources/isps/methods/list) client.ZeroTrust.DEX.Devices.ISPs.List(ctx, deviceID, params) (\*V4PagePagination\[[ISPs]()], error) GET/accounts/{account\_id}/dex/devices/{device\_id}/isps ##### ModelsExpand Collapse

type ISPs struct{…}

ISPs \[]ISPsISP

TestID string The test that generated this result. Link to this property TestResultID string The specific test result. Link to this property TimeStart Time Timestamp of when the ISP was observed. formatdate-time Link to this property

IP ISPsISPsIPOptional IP address information for the ISP hop. Fields marked as PII-gated (name, address, netmask, and all location sub-fields) will be returned as the literal string "REDACTED" for callers that do not have the PII permission. asn, aso, and version are always returned regardless of PII access.

Address stringOptional IP address. Returned as "REDACTED" without PII permission. Link to this property ASN int64Optional Autonomous System Number. Link to this property Aso stringOptional Autonomous System Organization name. Link to this property

Location ISPsISPsIPLocationOptional Geographic location information. All fields are returned as the literal string "REDACTED" for callers that do not have the PII permission.

City stringOptional City name. Returned as "REDACTED" without PII permission. Link to this property CountryISO stringOptional Country ISO code. Returned as "REDACTED" without PII permission. Link to this property StateISO stringOptional State/province ISO code. Returned as "REDACTED" without PII permission. Link to this property Zip stringOptional ZIP/postal code. Returned as "REDACTED" without PII permission. Link to this property

Link to this property Name stringOptional Named IP address (reverse DNS hostname when available). Returned as "REDACTED" without PII permission. Link to this property Netmask stringOptional Network mask. Returned as "REDACTED" without PII permission. Link to this property Version int64Optional IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.devices.isps%20%3E%20(model)%20isps%20%3E%20(schema)>)