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

DigitalExperienceMonitor {id, default, name }

id: string API Resource UUID tag. maxLength36 Link to this property default: boolean 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)>)

NetworkPath {slots, sampling }

slots: Array<Slot>

id: string API Resource UUID tag. maxLength36 Link to this property clientToAppRttMs: number| null Round trip time in ms of the client to app mile Link to this property clientToCfEgressRttMs: number| null Round trip time in ms of the client to Cloudflare egress mile Link to this property clientToCfIngressRttMs: number| null Round trip time in ms of the client to Cloudflare ingress mile Link to this property timestamp: string Link to this property clientToIspRttMs?: number| null Round trip time in ms of the client to ISP mile Link to this property

Link to this property

sampling?: Sampling| null 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: "hours" Link to this property value: number 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)>)

NetworkPathResponse {id, deviceName, interval, 4 more }

id: string API Resource UUID tag. maxLength36 Link to this property deviceName?: string Name of the device that ran the 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?: "traceroute" Link to this property name?: string Link to this property networkPath?: NetworkPath {slots, sampling } | null Link to this property url?: string 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)>)

Percentiles {p50, p90, p95, p99 }

p50?: number| null p50 observed in the time period. Link to this property p90?: number| null p90 observed in the time period. Link to this property p95?: number| null p95 observed in the time period. Link to this property p99?: number| null 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/typescript/resources/zero_trust/subresources/dex/subresources/warp_change_events/methods/get) client.zeroTrust.dex.warpChangeEvents.get(WARPChangeEventGetParams {account\_id, from, page, 7 more } params, RequestOptionsoptions?): [WARPChangeEventGetResponse]() {, } GET/accounts/{account\_id}/dex/warp-change-events ##### ModelsExpand Collapse

WARPChangeEventGetResponse = Array<DigitalExperienceMonitoringWARPToggleChangeEvent {account\_name, account\_tag, device\_id, 7 more } | DigitalExperienceMonitoringWARPConfigChangeEvent {device\_id, device\_registration, from, 6 more } >

One of the following:

DigitalExperienceMonitoringWARPToggleChangeEvent {account\_name, account\_tag, device\_id, 7 more }

account\_name?: string The account name. Link to this property account\_tag?: string The public account identifier. Link to this property device\_id?: string The device ID. maxLength36 Link to this property Deprecateddevice\_registration?: string Use registration_id instead. Deprecated: use registration\_id. The device registration ID. maxLength36 Link to this property hostname?: string The hostname of the machine the event is from. Link to this property registration\_id?: string The device registration ID. maxLength36 Link to this property serial\_number?: string The serial number of the machine the event is from. Link to this property timestamp?: string The event time. formatdate-time Link to this property

toggle?: "on"| "off" The state of the WARP toggle.

One of the following: "on" Link to this property "off" Link to this property

Link to this property user\_email?: string Email tied to the device. Link to this property

Link to this property

DigitalExperienceMonitoringWARPConfigChangeEvent {device\_id, device\_registration, from, 6 more }

device\_id?: string The device ID. maxLength36 Link to this property Deprecateddevice\_registration?: string Use registration_id instead. Deprecated: use registration\_id. The device registration ID. maxLength36 Link to this property

from?: From {account\_name, account\_tag, config\_name } The details for the WARP configuration that was switched from.

account\_name?: string The account name. Link to this property account\_tag?: string The public account identifier. maxLength36 Link to this property config\_name?: string The name of the WARP configuration. Link to this property

Link to this property hostname?: string The hostname of the machine the event is from. Link to this property registration\_id?: string The device registration ID. maxLength36 Link to this property serial\_number?: string The serial number of the machine the event is from. Link to this property timestamp?: string The event time. formatdate-time Link to this property

to?: To {account\_name, account\_tag, config\_name } The details for the WARP configuration that was switched to.

account\_name?: string The account name. Link to this property account\_tag?: string The public account identifier. maxLength36 Link to this property config\_name?: string The name of the WARP configuration. Link to this property

Link to this property user\_email?: string Email tied to the device. Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.warp_change_events%20%3E%20(model)%20warp_change_event_get_response%20%3E%20(schema)>) #### DEXCommands ##### [List account commands](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/commands/methods/list) client.zeroTrust.dex.commands.list(CommandListParams {account\_id, page, per\_page, 6 more } params, RequestOptionsoptions?): V4PagePagination< [CommandListResponse]() {commands } > GET/accounts/{account\_id}/dex/commands ##### [Create account commands](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/commands/methods/create) client.zeroTrust.dex.commands.create(CommandCreateParams {account\_id, commands } params, RequestOptionsoptions?): [CommandCreateResponse]() {commands } POST/accounts/{account\_id}/dex/commands ##### ModelsExpand Collapse

CommandListResponse {commands }

commands?: Array<Command>

id?: string Link to this property completed\_date?: string| null formatdate-time Link to this property created\_date?: string formatdate-time Link to this property device\_id?: string Link to this property filename?: string| null Link to this property registration\_id?: string Unique identifier for the device registration Link to this property status?: string Link to this property type?: string Link to this property user\_email?: string Link to this property

Link to this property

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

CommandCreateResponse {commands }

commands?: Array<Command> List of created commands

id?: string Unique identifier for the command Link to this property args?: Record<string, string> Command arguments Link to this property device\_id?: string Identifier for the device associated with the command Link to this property registration\_id?: string Unique identifier for the device registration Link to this property

status?: "PENDING\_EXEC"| "PENDING\_UPLOAD"| "SUCCESS"| "FAILED" Current status of the command

One of the following: "PENDING\_EXEC" Link to this property "PENDING\_UPLOAD" Link to this property "SUCCESS" Link to this property "FAILED" Link to this property

Link to this property type?: string Type of the command (e.g., “pcap”, “speed-test”, or “warp-diag”) Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.commands%20%3E%20(model)%20command_create_response%20%3E%20(schema)>) #### DEXCommandsDevices ##### [List devices eligible for remote captures](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/commands/subresources/devices/methods/list) client.zeroTrust.dex.commands.devices.list(DeviceListParams {account\_id, page, per\_page, search } params, RequestOptionsoptions?): V4PagePagination< [DeviceListResponse]() {devices } > GET/accounts/{account\_id}/dex/commands/devices ##### ModelsExpand Collapse

DeviceListResponse {devices }

devices?: Array<Device> List of eligible devices

deviceId?: string Device identifier (UUID v4) Link to this property deviceName?: string Device identifier (human readable) Link to this property eligible?: boolean Whether the device is eligible for remote captures Link to this property ineligibleReason?: string If the device is not eligible, the reason why. Link to this property personEmail?: string User contact email address Link to this property platform?: string Operating system. Link to this property registrationId?: string Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device. Link to this property status?: string Network status. Link to this property timestamp?: string Link to this property version?: string WARP client version. Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.commands.devices%20%3E%20(model)%20device_list_response%20%3E%20(schema)>) #### DEXCommandsDownloads ##### [Download command output file](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/commands/subresources/downloads/methods/get) client.zeroTrust.dex.commands.downloads.get(stringfilename, DownloadGetParams {account\_id, command\_id } params, RequestOptionsoptions?): Response GET/accounts/{account\_id}/dex/commands/{command\_id}/downloads/{filename} #### DEXCommandsQuota ##### [Returns account commands usage, quota, and reset time](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/commands/subresources/quota/methods/get) client.zeroTrust.dex.commands.quota.get(QuotaGetParams {account\_id } params, RequestOptionsoptions?): [QuotaGetResponse]() {quota, quota\_usage, reset\_time } GET/accounts/{account\_id}/dex/commands/quota ##### ModelsExpand Collapse

QuotaGetResponse {quota, quota\_usage, reset\_time }

quota: number The total number of commands that can be initiated for an account. Link to this property quota\_usage: number The number of commands that have been initiated for an account. Link to this property reset\_time: string The time when the quota resets. formatdate-time Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.commands.quota%20%3E%20(model)%20quota_get_response%20%3E%20(schema)>) #### DEXColos ##### [List Cloudflare colos](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/colos/methods/list) client.zeroTrust.dex.colos.list(ColoListParams {account\_id, from, to, sortBy } params, RequestOptionsoptions?): SinglePage< [ColoListResponse]() {airportCode, city, countryCode } > GET/accounts/{account\_id}/dex/colos ##### ModelsExpand Collapse

ColoListResponse {airportCode, city, countryCode }

airportCode: string Airport code Link to this property city: string City Link to this property countryCode: string Country code Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.colos%20%3E%20(model)%20colo_list_response%20%3E%20(schema)>) #### DEXFleet Status ##### [Get live aggregate device details by dimension](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/live) client.zeroTrust.dex.fleetStatus.live(FleetStatusLiveParams {account\_id, since\_minutes } params, RequestOptionsoptions?): [FleetStatusLiveResponse]() {deviceStats } GET/accounts/{account\_id}/dex/fleet-status/live ##### [Get over time aggregate details for devices by dimension](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/over_time) client.zeroTrust.dex.fleetStatus.overTime(FleetStatusOverTimeParams {account\_id, from, to, 2 more } params, RequestOptionsoptions?): [FleetStatusOverTimeResponse]() {deviceStats } GET/accounts/{account\_id}/dex/fleet-status/over-time ##### ModelsExpand Collapse

LiveStat {uniqueDevicesTotal, value }

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

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

FleetStatusLiveResponse {deviceStats }

deviceStats?: DeviceStats {byColo, byMode, byPlatform, 3 more }

byColo?: Array<LiveStat {uniqueDevicesTotal, value } >| null

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property

byMode?: Array<LiveStat {uniqueDevicesTotal, value } >| null

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property

byPlatform?: Array<LiveStat {uniqueDevicesTotal, value } >| null

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property

byStatus?: Array<LiveStat {uniqueDevicesTotal, value } >| null

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property

byVersion?: Array<LiveStat {uniqueDevicesTotal, value } >| null

uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property uniqueDevicesTotal?: number Number of unique devices Link to this property

Link to this property

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

FleetStatusOverTimeResponse {deviceStats }

deviceStats?: DeviceStats {byMode, byStatus, uniqueDevicesTotal }

byMode?: Array<ByMode>

timestamp?: string Link to this property uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property

byStatus?: Array<ByStatus>

timestamp?: string Link to this property uniqueDevicesTotal?: number Number of unique devices Link to this property value?: string Link to this property

Link to this property uniqueDevicesTotal?: number Number of unique devices Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.fleet_status%20%3E%20(model)%20fleet_status_over_time_response%20%3E%20(schema)>) #### DEXFleet StatusDevices ##### [List details of devices using WARP.](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/fleet_status/subresources/devices/methods/list) client.zeroTrust.dex.fleetStatus.devices.list(DeviceListParams {account\_id, from, page, 10 more } params, RequestOptionsoptions?): V4PagePaginationArray< [DeviceListResponse]() {colo, deviceId, mode, 40 more } > GET/accounts/{account\_id}/dex/fleet-status/devices ##### ModelsExpand Collapse

DeviceListResponse {colo, deviceId, mode, 40 more }

colo: string Cloudflare colo airport code. Link to this property deviceId: string Device identifier (UUID v4) Link to this property mode: string The mode under which the WARP client is run. Link to this property platform: string Operating system. Link to this property status: string Network status. Link to this property timestamp: string Link to this property version: string WARP client version. Link to this property alwaysOn?: boolean| null Link to this property batteryCharging?: boolean| null Link to this property batteryCycles?: number| null formatint64 Link to this property batteryPct?: number| null formatfloat Link to this property connectionType?: string| null Link to this property cpuPct?: number| null formatfloat Link to this property

cpuPctByApp?: Array<CPUPctByApp>| null

cpu\_pct?: number| null CPU usage percentage, on a scale of 0 to 100. formatfloat maximum100 minimum0 Link to this property name?: string| null Application name. Link to this property

Link to this property

deviceIpv4?: DeviceIPV4| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property

deviceIpv6?: DeviceIPV6| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property deviceName?: string Device identifier (human readable). Link to this property DeprecateddeviceRegistration?: string| null Use registrationId instead. Deprecated: use registrationId. Device registration identifier (UUID). Link to this property diskReadBps?: number| null formatint64 Link to this property diskUsagePct?: number| null formatfloat Link to this property diskWriteBps?: number| null formatint64 Link to this property dohSubdomain?: string| null Link to this property estimatedLossPct?: number| null formatfloat Link to this property firewallEnabled?: boolean| null Link to this property

gatewayIpv4?: GatewayIPV4| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property

gatewayIpv6?: GatewayIPV6| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property handshakeLatencyMs?: number| null formatint64 Link to this property

ispIpv4?: ISPIPV4| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property

ispIpv6?: ISPIPV6| null

address?: string| null Link to this property asn?: number| null Link to this property aso?: string| null Link to this property

location?: Location {city, country\_iso, state\_iso, zip }

city?: string| null Link to this property country\_iso?: string| null Link to this property state\_iso?: string| null Link to this property zip?: string| null Link to this property

Link to this property name?: string| null Link to this property netmask?: string| null Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

Link to this property metal?: string| null Link to this property networkRcvdBps?: number| null formatint64 Link to this property networkSentBps?: number| null formatint64 Link to this property networkSsid?: string| null Link to this property personEmail?: string User contact email address Link to this property ramAvailableKb?: number| null formatint64 Link to this property ramUsedPct?: number| null formatfloat Link to this property

ramUsedPctByApp?: Array<RamUsedPctByApp>| null

name?: string| null Application name. Link to this property ram\_used\_pct?: number| null RAM usage percentage, on a scale of 0 to 100. formatfloat maximum100 minimum0 Link to this property

Link to this property registrationId?: string| null Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device. Link to this property

rtt?: RTT| null Round-trip time statistics for the WARP tunnel.

minRttUs?: MinRTTUs| null Minimum round-trip time in microseconds.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

rttUs?: RTTUs| null Round-trip time in microseconds.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

rttVarUs?: RTTVarUs| null Round-trip time variance in microseconds.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

Link to this property switchLocked?: boolean| null Link to this property

tunnelStats?: TunnelStats| null WARP tunnel packet and byte counters.

bytesLost?: BytesLost| null Number of bytes lost, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

bytesReceived?: BytesReceived| null Number of bytes received, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

bytesRetransmitted?: BytesRetransmitted| null Number of bytes retransmitted, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

bytesSent?: BytesSent| null Number of bytes sent, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

packetsLost?: PacketsLost| null Number of packets lost, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

packetsReceived?: PacketsReceived| null Number of packets received, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

packetsRetransmitted?: PacketsRetransmitted| null Number of packets retransmitted, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property

packetsSent?: PacketsSent| null Number of packets sent, split by direction.

downstream?: number| null Link to this property upstream?: number| null Link to this property

Link to this property statsWindowMs?: number| null The measurement window duration in milliseconds. Link to this property

Link to this property tunnelType?: string| null Link to this property wifiStrengthDbm?: number| null formatint64 Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.fleet_status.devices%20%3E%20(model)%20device_list_response%20%3E%20(schema)>) #### DEXHTTP Tests ##### [Get details and aggregate metrics for an http test](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/http_tests/methods/get) client.zeroTrust.dex.httpTests.get(stringtestID, HTTPTestGetParams {account\_id, from, interval, 3 more } params, RequestOptionsoptions?): [HTTPDetails]() {host, httpStats, httpStatsByColo, 6 more } GET/accounts/{account\_id}/dex/http-tests/{test\_id} ##### ModelsExpand Collapse

HTTPDetails {host, httpStats, httpStatsByColo, 6 more }

host?: string The url of the HTTP synthetic application test. Link to this property

httpStats?: HTTPStats| null

availabilityPct: AvailabilityPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property dnsResponseTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property

httpStatusCode: Array<HTTPStatusCode>

status200: number Link to this property status300: number Link to this property status400: number Link to this property status500: number Link to this property timestamp: string Link to this property

Link to this property resourceFetchTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property serverResponseTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property uniqueDevicesTotal: number Count of unique devices that have run this test in the given time period. Link to this property

Link to this property

httpStatsByColo?: Array<HTTPStatsByColo>

availabilityPct: AvailabilityPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property colo: string Link to this property dnsResponseTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property

httpStatusCode: Array<HTTPStatusCode>

status200: number Link to this property status300: number Link to this property status400: number Link to this property status500: number Link to this property timestamp: string Link to this property

Link to this property resourceFetchTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property serverResponseTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property uniqueDevicesTotal: number Count of unique devices that have run this test in the given time period. Link to this property

Link to this property interval?: string The interval at which the HTTP synthetic application test is set to run. Link to this property kind?: "http" Link to this property method?: string The HTTP method to use when running the test. Link to this property name?: string The name of the HTTP synthetic application test. Link to this property

target\_policies?: Array<DigitalExperienceMonitor {id, default, name } >| null

id: string API Resource UUID tag. maxLength36 Link to this property default: boolean Whether the policy is the default for the account. Link to this property name: string Link to this property

Link to this property targeted?: boolean 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/typescript/resources/zero_trust/subresources/dex/subresources/http_tests/subresources/percentiles/methods/get) client.zeroTrust.dex.httpTests.percentiles.get(stringtestID, PercentileGetParams {account\_id, from, to, 2 more } params, RequestOptionsoptions?): [HTTPDetailsPercentiles]() {dnsResponseTimeMs, resourceFetchTimeMs, serverResponseTimeMs } GET/accounts/{account\_id}/dex/http-tests/{test\_id}/percentiles ##### ModelsExpand Collapse

HTTPDetailsPercentiles {dnsResponseTimeMs, resourceFetchTimeMs, serverResponseTimeMs }

dnsResponseTimeMs?: Percentiles {p50, p90, p95, p99 } Link to this property resourceFetchTimeMs?: Percentiles {p50, p90, p95, p99 } Link to this property serverResponseTimeMs?: Percentiles {p50, p90, p95, p99 } 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)>)

TestStatOverTime {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number Link to this property

Link to this property avg?: number| null average observed in the time period. Link to this property max?: number| null highest observed in the time period. Link to this property min?: number| null 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/typescript/resources/zero_trust/subresources/dex/subresources/tests/methods/list) client.zeroTrust.dex.tests.list(TestListParams {account\_id, colo, deviceId, 5 more } params, RequestOptionsoptions?): V4PagePagination< [Tests]() {overviewMetrics, tests } > GET/accounts/{account\_id}/dex/tests/overview ##### ModelsExpand Collapse

AggregateTimePeriod {units, value }

units: "hours"| "days"| "testRuns"

One of the following: "hours" Link to this property "days" Link to this property "testRuns" Link to this property

Link to this property value: number Link to this property

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

Tests {overviewMetrics, tests }

overviewMetrics: OverviewMetrics {testsTotal, avgHttpAvailabilityPct, avgTracerouteAvailabilityPct }

testsTotal: number number of tests. Link to this property avgHttpAvailabilityPct?: number| null percentage availability for all HTTP test results in response. formatfloat Link to this property avgTracerouteAvailabilityPct?: number| null percentage availability for all traceroutes results in response. formatfloat Link to this property

Link to this property

tests: Array<Test> 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: boolean 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: "http"| "traceroute" test type, http or traceroute

One of the following: "http" Link to this property "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?: HTTPResults| null

resourceFetchTime: ResourceFetchTime {history, avgMs, overTime }

history: Array<History>

timePeriod: AggregateTimePeriod {units, value } Link to this property avgMs?: number| null Link to this property deltaPct?: number| null formatfloat Link to this property

Link to this property avgMs?: number| null Link to this property

overTime?: OverTime| null

timePeriod: AggregateTimePeriod {units, value } Link to this property

values: Array<Value>

avgMs: number Link to this property timestamp: string Link to this property

Link to this property

Link to this property

Link to this property

Link to this property

httpResultsByColo?: Array<HTTPResultsByColo>

colo: string Cloudflare colo Link to this property

resourceFetchTime: ResourceFetchTime {history, avgMs, overTime }

history: Array<History>

timePeriod: AggregateTimePeriod {units, value } Link to this property avgMs?: number| null Link to this property deltaPct?: number| null formatfloat Link to this property

Link to this property avgMs?: number| null Link to this property

overTime?: OverTime| null

timePeriod: AggregateTimePeriod {units, value } Link to this property

values: Array<Value>

avgMs: number Link to this property timestamp: string Link to this property

Link to this property

Link to this property

Link to this property

Link to this property method?: string for HTTP, the method to use when running the test Link to this property

target\_policies?: Array<DigitalExperienceMonitor {id, default, name } >| null

id: string API Resource UUID tag. maxLength36 Link to this property default: boolean Whether the policy is the default for the account. Link to this property name: string Link to this property

Link to this property targeted?: boolean Link to this property

tracerouteResults?: TracerouteResults| null

roundTripTime: RoundTripTime {history, avgMs, overTime }

history: Array<History>

timePeriod: AggregateTimePeriod {units, value } Link to this property avgMs?: number| null Link to this property deltaPct?: number| null formatfloat Link to this property

Link to this property avgMs?: number| null Link to this property

overTime?: OverTime| null

timePeriod: AggregateTimePeriod {units, value } Link to this property

values: Array<Value>

avgMs: number Link to this property timestamp: string Link to this property

Link to this property

Link to this property

Link to this property

Link to this property

tracerouteResultsByColo?: Array<TracerouteResultsByColo>

colo: string Cloudflare colo Link to this property

roundTripTime: RoundTripTime {history, avgMs, overTime }

history: Array<History>

timePeriod: AggregateTimePeriod {units, value } Link to this property avgMs?: number| null Link to this property deltaPct?: number| null formatfloat Link to this property

Link to this property avgMs?: number| null Link to this property

overTime?: OverTime| null

timePeriod: AggregateTimePeriod {units, value } Link to this property

values: Array<Value>

avgMs: number Link to this property timestamp: string Link to this property

Link to this property

Link to this property

Link to this property

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/typescript/resources/zero_trust/subresources/dex/subresources/tests/subresources/unique_devices/methods/list) client.zeroTrust.dex.tests.uniqueDevices.list(UniqueDeviceListParams {account\_id, deviceId, testName } params, RequestOptionsoptions?): [UniqueDevices]() {uniqueDevicesTotal } GET/accounts/{account\_id}/dex/tests/unique-devices ##### ModelsExpand Collapse

UniqueDevices {uniqueDevicesTotal }

uniqueDevicesTotal: number 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/typescript/resources/zero_trust/subresources/dex/subresources/traceroute_test_results/subresources/network_path/methods/get) client.zeroTrust.dex.tracerouteTestResults.networkPath.get(stringtestResultID, NetworkPathGetParams {account\_id } params, RequestOptionsoptions?): [NetworkPathGetResponse]() {hops, resultId, colo, 6 more } GET/accounts/{account\_id}/dex/traceroute-test-results/{test\_result\_id}/network-path ##### ModelsExpand Collapse

NetworkPathGetResponse {hops, resultId, colo, 6 more }

hops: Array<Hop> An array of the hops taken by the device to reach the end destination.

ttl: number Link to this property asn?: number| null Link to this property aso?: string| null Link to this property ipAddress?: string| null Link to this property

location?: Location| null

city?: string| null Link to this property state?: string| null Link to this property zip?: string| null Link to this property

Link to this property

mile?: "client-to-app"| "client-to-cf-egress"| "client-to-cf-ingress"| "client-to-isp"| null

One of the following: "client-to-app" Link to this property "client-to-cf-egress" Link to this property "client-to-cf-ingress" Link to this property "client-to-isp" Link to this property

Link to this property name?: string| null Link to this property packetLossPct?: number| null formatfloat Link to this property rttMs?: number| null Link to this property

Link to this property resultId: string API Resource UUID tag. maxLength36 Link to this property colo?: string Cloudflare colo airport code. Link to this property deviceName?: string Name of the device associated with this network path response. Link to this property

execution\_context?: "EXECUTION\_CONTEXT\_INVALID"| "OUT\_OF\_TUNNEL"| "IN\_TUNNEL" Whether the test was run inside or outside of the WARP tunnel.

One of the following: "EXECUTION\_CONTEXT\_INVALID" Link to this property "OUT\_OF\_TUNNEL" Link to this property "IN\_TUNNEL" Link to this property

Link to this property testId?: string API Resource UUID tag. maxLength36 Link to this property testName?: string Name of the traceroute test. Link to this property time\_start?: string Timestamp indicating when the traceroute test execution began. Link to this property tunnel\_type?: string| null Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.traceroute_test_results.network_path%20%3E%20(model)%20network_path_get_response%20%3E%20(schema)>) #### DEXTraceroute Tests ##### [Get details and aggregate metrics for a traceroute test](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/get) client.zeroTrust.dex.tracerouteTests.get(stringtestID, TracerouteTestGetParams {account\_id, from, interval, 3 more } params, RequestOptionsoptions?): [Traceroute]() {host, interval, kind, 5 more } GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id} ##### [Get percentiles for a traceroute test](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/percentiles) client.zeroTrust.dex.tracerouteTests.percentiles(stringtestID, TracerouteTestPercentilesParams {account\_id, from, to, 2 more } params, RequestOptionsoptions?): [TracerouteTestPercentilesResponse]() {hopsCount, packetLossPct, roundTripTimeMs } GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/percentiles ##### [Get network path breakdown for a traceroute test](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/network_path) client.zeroTrust.dex.tracerouteTests.networkPath(stringtestID, TracerouteTestNetworkPathParams {account\_id, deviceId, from, 2 more } params, RequestOptionsoptions?): [NetworkPathResponse]() {id, deviceName, interval, 4 more } GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/network-path ##### ModelsExpand Collapse

Traceroute {host, interval, kind, 5 more }

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: "traceroute" Link to this property name: string The name of the Traceroute synthetic application test. Link to this property

target\_policies?: Array<DigitalExperienceMonitor {id, default, name } >| null

id: string API Resource UUID tag. maxLength36 Link to this property default: boolean Whether the policy is the default for the account. Link to this property name: string Link to this property

Link to this property targeted?: boolean Link to this property

tracerouteStats?: TracerouteStats| null

availabilityPct: AvailabilityPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property hopsCount: TestStatOverTime {slots, avg, max, min } Link to this property

packetLossPct: PacketLossPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property roundTripTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property uniqueDevicesTotal: number Count of unique devices that have run this test in the given time period. Link to this property

Link to this property

tracerouteStatsByColo?: Array<TracerouteStatsByColo>

availabilityPct: AvailabilityPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property colo: string Link to this property hopsCount: TestStatOverTime {slots, avg, max, min } Link to this property

packetLossPct: PacketLossPct {slots, avg, max, min }

slots: Array<Slot>

timestamp: string Link to this property value: number formatfloat Link to this property

Link to this property avg?: number| null average observed in the time period. formatfloat Link to this property max?: number| null highest observed in the time period. formatfloat Link to this property min?: number| null lowest observed in the time period. formatfloat Link to this property

Link to this property roundTripTimeMs: TestStatOverTime {slots, avg, max, min } Link to this property uniqueDevicesTotal: number 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)>)

TracerouteTestPercentilesResponse {hopsCount, packetLossPct, roundTripTimeMs }

hopsCount?: Percentiles {p50, p90, p95, p99 } Link to this property packetLossPct?: Percentiles {p50, p90, p95, p99 } Link to this property roundTripTimeMs?: Percentiles {p50, p90, p95, p99 } Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.traceroute_tests%20%3E%20(model)%20traceroute_test_percentiles_response%20%3E%20(schema)>) #### DEXRules ##### [Get DEX Rule](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/rules/methods/get) client.zeroTrust.dex.rules.get(stringruleID, RuleGetParams {account\_id } params, RequestOptionsoptions?): [RuleGetResponse]() {id, created\_at, match, 4 more } GET/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Delete a DEX Rule](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/rules/methods/delete) client.zeroTrust.dex.rules.delete(stringruleID, RuleDeleteParams {account\_id } params, RequestOptionsoptions?): [RuleDeleteResponse]()| null DELETE/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Update a DEX Rule](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/rules/methods/update) client.zeroTrust.dex.rules.update(stringruleID, RuleUpdateParams {account\_id, description, match, name } params, RequestOptionsoptions?): [RuleUpdateResponse]() {id, created\_at, match, 4 more } PATCH/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Create a DEX Rule](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/rules/methods/create) client.zeroTrust.dex.rules.create(RuleCreateParams {account\_id, match, name, description } params, RequestOptionsoptions?): [RuleCreateResponse]() {id, created\_at, match, 4 more } POST/accounts/{account\_id}/dex/rules ##### [List DEX Rules](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/rules/methods/list) client.zeroTrust.dex.rules.list(RuleListParams {account\_id, page, per\_page, 3 more } params, RequestOptionsoptions?): V4PagePagination< [RuleListResponse]() {rules } > GET/accounts/{account\_id}/dex/rules ##### ModelsExpand Collapse

RuleGetResponse {id, created\_at, match, 4 more }

id: string API Resource UUID tag. maxLength36 Link to this property created\_at: string Link to this property match: string Link to this property name: string Link to this property description?: string Link to this property

targeted\_tests?: Array<TargetedTest>

data: SchemaData {host, kind, method } The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: boolean Link to this property name: string Link to this property test\_id: string Link to this property

Link to this property updated\_at?: string Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>) RuleDeleteResponse = boolean| null [Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)

RuleUpdateResponse {id, created\_at, match, 4 more }

id: string API Resource UUID tag. maxLength36 Link to this property created\_at: string Link to this property match: string Link to this property name: string Link to this property description?: string Link to this property

targeted\_tests?: Array<TargetedTest>

data: SchemaData {host, kind, method } The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: boolean Link to this property name: string Link to this property test\_id: string Link to this property

Link to this property updated\_at?: string Link to this property

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

RuleCreateResponse {id, created\_at, match, 4 more }

id: string API Resource UUID tag. maxLength36 Link to this property created\_at: string Link to this property match: string Link to this property name: string Link to this property description?: string Link to this property

targeted\_tests?: Array<TargetedTest>

data: SchemaData {host, kind, method } The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: boolean Link to this property name: string Link to this property test\_id: string Link to this property

Link to this property updated\_at?: string Link to this property

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

RuleListResponse {rules }

rules?: Array<Rule>

id: string API Resource UUID tag. maxLength36 Link to this property created\_at: string Link to this property match: string Link to this property name: string Link to this property description?: string Link to this property

targeted\_tests?: Array<TargetedTest>

data: SchemaData {host, kind, method } The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: boolean Link to this property name: string Link to this property test\_id: string Link to this property

Link to this property updated\_at?: string Link to this property

Link to this property

[Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>) #### DEXDevices #### DEXDevicesISPs ##### [List device ISPs](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/dex/subresources/devices/subresources/isps/methods/list) client.zeroTrust.dex.devices.isps.list(stringdeviceID, ISPListParams {account\_id, per\_page, cursor, 5 more } params, RequestOptionsoptions?): V4PagePagination< [ISPs]() {isps } > GET/accounts/{account\_id}/dex/devices/{device\_id}/isps ##### ModelsExpand Collapse

ISPs {isps }

isps: Array<ISP>

test\_id: string The test that generated this result. Link to this property test\_result\_id: string The specific test result. Link to this property time\_start: string Timestamp of when the ISP was observed. formatdate-time Link to this property

ip?: IP {address, asn, aso, 4 more } 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?: string IP address. Returned as "REDACTED" without PII permission. Link to this property asn?: number Autonomous System Number. Link to this property aso?: string Autonomous System Organization name. Link to this property

location?: Location {city, country\_iso, state\_iso, zip } Geographic location information. All fields are returned as the literal string "REDACTED" for callers that do not have the PII permission.

city?: string City name. Returned as "REDACTED" without PII permission. Link to this property country\_iso?: string Country ISO code. Returned as "REDACTED" without PII permission. Link to this property state\_iso?: string State/province ISO code. Returned as "REDACTED" without PII permission. Link to this property zip?: string ZIP/postal code. Returned as "REDACTED" without PII permission. Link to this property

Link to this property name?: string Named IP address (reverse DNS hostname when available). Returned as "REDACTED" without PII permission. Link to this property netmask?: string Network mask. Returned as "REDACTED" without PII permission. Link to this property version?: number IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property

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)>)