--- title: DEX --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zero Trust](https://developers.cloudflare.com/api/python/resources/zero_trust) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # DEX ##### ModelsExpand Collapse
class DigitalExperienceMonitor: … id: str 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: str Link to this property
[Link to this property](<#(resource)%20zero_trust.dex%20%3E%20(model)%20digital_experience_monitor%20%3E%20(schema)>)
class NetworkPath: …
slots: List\[Slot] id: str API Resource UUID tag. maxLength36 Link to this property client\_to\_app\_rtt\_ms: Optional\[int] Round trip time in ms of the client to app mile Link to this property client\_to\_cf\_egress\_rtt\_ms: Optional\[int] Round trip time in ms of the client to Cloudflare egress mile Link to this property client\_to\_cf\_ingress\_rtt\_ms: Optional\[int] Round trip time in ms of the client to Cloudflare ingress mile Link to this property timestamp: str Link to this property client\_to\_isp\_rtt\_ms: Optional\[int] Round trip time in ms of the client to ISP mile Link to this property
Link to this property
sampling: Optional\[Sampling] 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: Literal\["hours"] Link to this property value: int 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)>)
class NetworkPathResponse: … id: str API Resource UUID tag. maxLength36 Link to this property device\_name: Optional\[str] Name of the device that ran the test. Link to this property interval: Optional\[str] The interval at which the Traceroute synthetic application test is set to run. Link to this property kind: Optional\[Literal\["traceroute"]] Link to this property name: Optional\[str] Link to this property network\_path: Optional\[NetworkPath] Link to this property url: Optional\[str] 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)>)
class Percentiles: … p50: Optional\[float] p50 observed in the time period. Link to this property p90: Optional\[float] p90 observed in the time period. Link to this property p95: Optional\[float] p95 observed in the time period. Link to this property p99: Optional\[float] 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/python/resources/zero_trust/subresources/dex/subresources/warp_change_events/methods/get) zero\_trust.dex.warp\_change\_events.get(WARPChangeEventGetParams\*\*kwargs) -> [WARPChangeEventGetResponse]() GET/accounts/{account\_id}/dex/warp-change-events ##### ModelsExpand Collapse
List\[WARPChangeEventGetResponseItem] One of the following:
class WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPToggleChangeEvent: … account\_name: Optional\[str] The account name. Link to this property account\_tag: Optional\[str] The public account identifier. Link to this property device\_id: Optional\[str] The device ID. maxLength36 Link to this property Deprecateddevice\_registration: Optional\[str] Use registration_id instead. Deprecated: use registration\_id. The device registration ID. maxLength36 Link to this property hostname: Optional\[str] The hostname of the machine the event is from. Link to this property registration\_id: Optional\[str] The device registration ID. maxLength36 Link to this property serial\_number: Optional\[str] The serial number of the machine the event is from. Link to this property timestamp: Optional\[datetime] The event time. formatdate-time Link to this property
toggle: Optional\[Literal\["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: Optional\[str] Email tied to the device. Link to this property
Link to this property
class WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEvent: … device\_id: Optional\[str] The device ID. maxLength36 Link to this property Deprecateddevice\_registration: Optional\[str] Use registration_id instead. Deprecated: use registration\_id. The device registration ID. maxLength36 Link to this property
from\_: Optional\[WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEventFrom] The details for the WARP configuration that was switched from. account\_name: Optional\[str] The account name. Link to this property account\_tag: Optional\[str] The public account identifier. maxLength36 Link to this property config\_name: Optional\[str] The name of the WARP configuration. Link to this property
Link to this property hostname: Optional\[str] The hostname of the machine the event is from. Link to this property registration\_id: Optional\[str] The device registration ID. maxLength36 Link to this property serial\_number: Optional\[str] The serial number of the machine the event is from. Link to this property timestamp: Optional\[datetime] The event time. formatdate-time Link to this property
to: Optional\[WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEventTo] The details for the WARP configuration that was switched to. account\_name: Optional\[str] The account name. Link to this property account\_tag: Optional\[str] The public account identifier. maxLength36 Link to this property config\_name: Optional\[str] The name of the WARP configuration. Link to this property
Link to this property user\_email: Optional\[str] 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/python/resources/zero_trust/subresources/dex/subresources/commands/methods/list) zero\_trust.dex.commands.list(CommandListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[CommandListResponse]] GET/accounts/{account\_id}/dex/commands ##### [Create account commands](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/commands/methods/create) zero\_trust.dex.commands.create(CommandCreateParams\*\*kwargs) -> [CommandCreateResponse]() POST/accounts/{account\_id}/dex/commands ##### ModelsExpand Collapse
class CommandListResponse: …
commands: Optional\[List\[Command]] id: Optional\[str] Link to this property completed\_date: Optional\[datetime] formatdate-time Link to this property created\_date: Optional\[datetime] formatdate-time Link to this property device\_id: Optional\[str] Link to this property filename: Optional\[str] Link to this property registration\_id: Optional\[str] Unique identifier for the device registration Link to this property status: Optional\[str] Link to this property type: Optional\[str] Link to this property user\_email: Optional\[str] 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)>)
class CommandCreateResponse: …
commands: Optional\[List\[Command]] List of created commands id: Optional\[str] Unique identifier for the command Link to this property args: Optional\[Dict\[str, str]] Command arguments Link to this property device\_id: Optional\[str] Identifier for the device associated with the command Link to this property registration\_id: Optional\[str] Unique identifier for the device registration Link to this property
status: Optional\[Literal\["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: Optional\[str] 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/python/resources/zero_trust/subresources/dex/subresources/commands/subresources/devices/methods/list) zero\_trust.dex.commands.devices.list(DeviceListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[DeviceListResponse]] GET/accounts/{account\_id}/dex/commands/devices ##### ModelsExpand Collapse
class DeviceListResponse: …
devices: Optional\[List\[Device]] List of eligible devices device\_id: Optional\[str] Device identifier (UUID v4) Link to this property device\_name: Optional\[str] Device identifier (human readable) Link to this property eligible: Optional\[bool] Whether the device is eligible for remote captures Link to this property ineligible\_reason: Optional\[str] If the device is not eligible, the reason why. Link to this property person\_email: Optional\[str] User contact email address Link to this property platform: Optional\[str] Operating system. Link to this property registration\_id: Optional\[str] Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device. Link to this property status: Optional\[str] Network status. Link to this property timestamp: Optional\[str] Link to this property version: Optional\[str] 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/python/resources/zero_trust/subresources/dex/subresources/commands/subresources/downloads/methods/get) zero\_trust.dex.commands.downloads.get(strfilename, DownloadGetParams\*\*kwargs) -> BinaryResponseContent GET/accounts/{account\_id}/dex/commands/{command\_id}/downloads/{filename} #### DEXCommandsQuota ##### [Returns account commands usage, quota, and reset time](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/commands/subresources/quota/methods/get) zero\_trust.dex.commands.quota.get(QuotaGetParams\*\*kwargs) -> [QuotaGetResponse]() GET/accounts/{account\_id}/dex/commands/quota ##### ModelsExpand Collapse
class QuotaGetResponse: … quota: float The total number of commands that can be initiated for an account. Link to this property quota\_usage: float The number of commands that have been initiated for an account. Link to this property reset\_time: datetime 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/python/resources/zero_trust/subresources/dex/subresources/colos/methods/list) zero\_trust.dex.colos.list(ColoListParams\*\*kwargs) -> SyncSinglePage\[[ColoListResponse]()] GET/accounts/{account\_id}/dex/colos ##### ModelsExpand Collapse
class ColoListResponse: … airport\_code: str Airport code Link to this property city: str City Link to this property country\_code: str 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/python/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/live) zero\_trust.dex.fleet\_status.live(FleetStatusLiveParams\*\*kwargs) -> [FleetStatusLiveResponse]() GET/accounts/{account\_id}/dex/fleet-status/live ##### [Get over time aggregate details for devices by dimension](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/fleet_status/methods/over_time) zero\_trust.dex.fleet\_status.over\_time(FleetStatusOverTimeParams\*\*kwargs) -> [FleetStatusOverTimeResponse]() GET/accounts/{account\_id}/dex/fleet-status/over-time ##### ModelsExpand Collapse
class LiveStat: … unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
[Link to this property](<#(resource)%20zero_trust.dex.fleet_status%20%3E%20(model)%20live_stat%20%3E%20(schema)>)
class FleetStatusLiveResponse: …
device\_stats: Optional\[DeviceStats]
by\_colo: Optional\[List\[LiveStat]] unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property
by\_mode: Optional\[List\[LiveStat]] unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property
by\_platform: Optional\[List\[LiveStat]] unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property
by\_status: Optional\[List\[LiveStat]] unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property
by\_version: Optional\[List\[LiveStat]] unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property unique\_devices\_total: Optional\[float] 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)>)
class FleetStatusOverTimeResponse: …
device\_stats: Optional\[DeviceStats]
by\_mode: Optional\[List\[DeviceStatsByMode]] timestamp: Optional\[str] Link to this property unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property
by\_status: Optional\[List\[DeviceStatsByStatus]] timestamp: Optional\[str] Link to this property unique\_devices\_total: Optional\[float] Number of unique devices Link to this property value: Optional\[str] Link to this property
Link to this property unique\_devices\_total: Optional\[float] 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/python/resources/zero_trust/subresources/dex/subresources/fleet_status/subresources/devices/methods/list) zero\_trust.dex.fleet\_status.devices.list(DeviceListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[DeviceListResponse]()] GET/accounts/{account\_id}/dex/fleet-status/devices ##### ModelsExpand Collapse
class DeviceListResponse: … colo: str Cloudflare colo airport code. Link to this property device\_id: str Device identifier (UUID v4) Link to this property mode: str The mode under which the WARP client is run. Link to this property platform: str Operating system. Link to this property status: str Network status. Link to this property timestamp: str Link to this property version: str WARP client version. Link to this property always\_on: Optional\[bool] Link to this property battery\_charging: Optional\[bool] Link to this property battery\_cycles: Optional\[int] formatint64 Link to this property battery\_pct: Optional\[float] formatfloat Link to this property connection\_type: Optional\[str] Link to this property cpu\_pct: Optional\[float] formatfloat Link to this property
cpu\_pct\_by\_app: Optional\[List\[CPUPctByApp]] cpu\_pct: Optional\[float] CPU usage percentage, on a scale of 0 to 100. formatfloat maximum100 minimum0 Link to this property name: Optional\[str] Application name. Link to this property
Link to this property
device\_ipv4: Optional\[DeviceIPV4] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[DeviceIPV4Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property
device\_ipv6: Optional\[DeviceIPV6] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[DeviceIPV6Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property device\_name: Optional\[str] Device identifier (human readable). Link to this property Deprecateddevice\_registration: Optional\[str] Use registrationId instead. Deprecated: use registrationId. Device registration identifier (UUID). Link to this property disk\_read\_bps: Optional\[int] formatint64 Link to this property disk\_usage\_pct: Optional\[float] formatfloat Link to this property disk\_write\_bps: Optional\[int] formatint64 Link to this property doh\_subdomain: Optional\[str] Link to this property estimated\_loss\_pct: Optional\[float] formatfloat Link to this property firewall\_enabled: Optional\[bool] Link to this property
gateway\_ipv4: Optional\[GatewayIPV4] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[GatewayIPV4Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property
gateway\_ipv6: Optional\[GatewayIPV6] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[GatewayIPV6Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property handshake\_latency\_ms: Optional\[float] formatint64 Link to this property
isp\_ipv4: Optional\[ISPIPV4] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[ISPIPV4Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property
isp\_ipv6: Optional\[ISPIPV6] address: Optional\[str] Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property
location: Optional\[ISPIPV6Location] city: Optional\[str] Link to this property country\_iso: Optional\[str] Link to this property state\_iso: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property name: Optional\[str] Link to this property netmask: Optional\[str] Link to this property version: Optional\[int] IP version (1 for IPv4, 2 for IPv6, 0 if unknown). Link to this property
Link to this property metal: Optional\[str] Link to this property network\_rcvd\_bps: Optional\[int] formatint64 Link to this property network\_sent\_bps: Optional\[int] formatint64 Link to this property network\_ssid: Optional\[str] Link to this property person\_email: Optional\[str] User contact email address Link to this property ram\_available\_kb: Optional\[int] formatint64 Link to this property ram\_used\_pct: Optional\[float] formatfloat Link to this property
ram\_used\_pct\_by\_app: Optional\[List\[RamUsedPctByApp]] name: Optional\[str] Application name. Link to this property ram\_used\_pct: Optional\[float] RAM usage percentage, on a scale of 0 to 100. formatfloat maximum100 minimum0 Link to this property
Link to this property registration\_id: Optional\[str] Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device. Link to this property
rtt: Optional\[RTT] Round-trip time statistics for the WARP tunnel.
min\_rtt\_us: Optional\[RTTMinRTTUs] Minimum round-trip time in microseconds. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
rtt\_us: Optional\[RTTRTTUs] Round-trip time in microseconds. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
rtt\_var\_us: Optional\[RTTRTTVarUs] Round-trip time variance in microseconds. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
Link to this property switch\_locked: Optional\[bool] Link to this property
tunnel\_stats: Optional\[TunnelStats] WARP tunnel packet and byte counters.
bytes\_lost: Optional\[TunnelStatsBytesLost] Number of bytes lost, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
bytes\_received: Optional\[TunnelStatsBytesReceived] Number of bytes received, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
bytes\_retransmitted: Optional\[TunnelStatsBytesRetransmitted] Number of bytes retransmitted, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
bytes\_sent: Optional\[TunnelStatsBytesSent] Number of bytes sent, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
packets\_lost: Optional\[TunnelStatsPacketsLost] Number of packets lost, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
packets\_received: Optional\[TunnelStatsPacketsReceived] Number of packets received, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
packets\_retransmitted: Optional\[TunnelStatsPacketsRetransmitted] Number of packets retransmitted, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property
packets\_sent: Optional\[TunnelStatsPacketsSent] Number of packets sent, split by direction. downstream: Optional\[int] Link to this property upstream: Optional\[int] Link to this property
Link to this property stats\_window\_ms: Optional\[int] The measurement window duration in milliseconds. Link to this property
Link to this property tunnel\_type: Optional\[str] Link to this property wifi\_strength\_dbm: Optional\[int] 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/python/resources/zero_trust/subresources/dex/subresources/http_tests/methods/get) zero\_trust.dex.http\_tests.get(strtest\_id, HTTPTestGetParams\*\*kwargs) -> [HTTPDetails]() GET/accounts/{account\_id}/dex/http-tests/{test\_id} ##### ModelsExpand Collapse
class HTTPDetails: … host: Optional\[str] The url of the HTTP synthetic application test. Link to this property
http\_stats: Optional\[HTTPStats]
availability\_pct: HTTPStatsAvailabilityPct
slots: List\[HTTPStatsAvailabilityPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property dns\_response\_time\_ms: TestStatOverTime Link to this property
http\_status\_code: List\[HTTPStatsHTTPStatusCode] status200: int Link to this property status300: int Link to this property status400: int Link to this property status500: int Link to this property timestamp: str Link to this property
Link to this property resource\_fetch\_time\_ms: TestStatOverTime Link to this property server\_response\_time\_ms: TestStatOverTime Link to this property unique\_devices\_total: int Count of unique devices that have run this test in the given time period. Link to this property
Link to this property
http\_stats\_by\_colo: Optional\[List\[HTTPStatsByColo]]
availability\_pct: HTTPStatsByColoAvailabilityPct
slots: List\[HTTPStatsByColoAvailabilityPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property colo: str Link to this property dns\_response\_time\_ms: TestStatOverTime Link to this property
http\_status\_code: List\[HTTPStatsByColoHTTPStatusCode] status200: int Link to this property status300: int Link to this property status400: int Link to this property status500: int Link to this property timestamp: str Link to this property
Link to this property resource\_fetch\_time\_ms: TestStatOverTime Link to this property server\_response\_time\_ms: TestStatOverTime Link to this property unique\_devices\_total: int Count of unique devices that have run this test in the given time period. Link to this property
Link to this property interval: Optional\[str] The interval at which the HTTP synthetic application test is set to run. Link to this property kind: Optional\[Literal\["http"]] Link to this property method: Optional\[str] The HTTP method to use when running the test. Link to this property name: Optional\[str] The name of the HTTP synthetic application test. Link to this property
target\_policies: Optional\[List\[DigitalExperienceMonitor]] id: str 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: str Link to this property
Link to this property targeted: Optional\[bool] 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/python/resources/zero_trust/subresources/dex/subresources/http_tests/subresources/percentiles/methods/get) zero\_trust.dex.http\_tests.percentiles.get(strtest\_id, PercentileGetParams\*\*kwargs) -> [HTTPDetailsPercentiles]() GET/accounts/{account\_id}/dex/http-tests/{test\_id}/percentiles ##### ModelsExpand Collapse
class HTTPDetailsPercentiles: … dns\_response\_time\_ms: Optional\[Percentiles] Link to this property resource\_fetch\_time\_ms: Optional\[Percentiles] Link to this property server\_response\_time\_ms: Optional\[Percentiles] 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)>)
class TestStatOverTime: …
slots: List\[Slot] timestamp: str Link to this property value: int Link to this property
Link to this property avg: Optional\[int] average observed in the time period. Link to this property max: Optional\[int] highest observed in the time period. Link to this property min: Optional\[int] 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/python/resources/zero_trust/subresources/dex/subresources/tests/methods/list) zero\_trust.dex.tests.list(TestListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[Tests]] GET/accounts/{account\_id}/dex/tests/overview ##### ModelsExpand Collapse
class AggregateTimePeriod: …
units: Literal\["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: int Link to this property
[Link to this property](<#(resource)%20zero_trust.dex.tests%20%3E%20(model)%20aggregate_time_period%20%3E%20(schema)>)
class Tests: …
overview\_metrics: OverviewMetrics tests\_total: int number of tests. Link to this property avg\_http\_availability\_pct: Optional\[float] percentage availability for all HTTP test results in response. formatfloat Link to this property avg\_traceroute\_availability\_pct: Optional\[float] percentage availability for all traceroutes results in response. formatfloat Link to this property
Link to this property
tests: List\[Test] array of test results objects. id: str API Resource UUID tag. maxLength36 Link to this property created: str date the test was created. Link to this property description: str 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: str Link to this property interval: str The interval at which the synthetic application test is set to run. Link to this property
kind: Literal\["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: str name given to this test Link to this property updated: str Link to this property
http\_results: Optional\[TestHTTPResults]
resource\_fetch\_time: TestHTTPResultsResourceFetchTime
history: List\[TestHTTPResultsResourceFetchTimeHistory] time\_period: AggregateTimePeriod Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property
Link to this property avg\_ms: Optional\[int] Link to this property
over\_time: Optional\[TestHTTPResultsResourceFetchTimeOverTime] time\_period: AggregateTimePeriod Link to this property
values: List\[TestHTTPResultsResourceFetchTimeOverTimeValue] avg\_ms: int Link to this property timestamp: str Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
http\_results\_by\_colo: Optional\[List\[TestHTTPResultsByColo]] colo: str Cloudflare colo Link to this property
resource\_fetch\_time: TestHTTPResultsByColoResourceFetchTime
history: List\[TestHTTPResultsByColoResourceFetchTimeHistory] time\_period: AggregateTimePeriod Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property
Link to this property avg\_ms: Optional\[int] Link to this property
over\_time: Optional\[TestHTTPResultsByColoResourceFetchTimeOverTime] time\_period: AggregateTimePeriod Link to this property
values: List\[TestHTTPResultsByColoResourceFetchTimeOverTimeValue] avg\_ms: int Link to this property timestamp: str Link to this property
Link to this property
Link to this property
Link to this property
Link to this property method: Optional\[str] for HTTP, the method to use when running the test Link to this property
target\_policies: Optional\[List\[DigitalExperienceMonitor]] id: str 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: str Link to this property
Link to this property targeted: Optional\[bool] Link to this property
traceroute\_results: Optional\[TestTracerouteResults]
round\_trip\_time: TestTracerouteResultsRoundTripTime
history: List\[TestTracerouteResultsRoundTripTimeHistory] time\_period: AggregateTimePeriod Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property
Link to this property avg\_ms: Optional\[int] Link to this property
over\_time: Optional\[TestTracerouteResultsRoundTripTimeOverTime] time\_period: AggregateTimePeriod Link to this property
values: List\[TestTracerouteResultsRoundTripTimeOverTimeValue] avg\_ms: int Link to this property timestamp: str Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
traceroute\_results\_by\_colo: Optional\[List\[TestTracerouteResultsByColo]] colo: str Cloudflare colo Link to this property
round\_trip\_time: TestTracerouteResultsByColoRoundTripTime
history: List\[TestTracerouteResultsByColoRoundTripTimeHistory] time\_period: AggregateTimePeriod Link to this property avg\_ms: Optional\[int] Link to this property delta\_pct: Optional\[float] formatfloat Link to this property
Link to this property avg\_ms: Optional\[int] Link to this property
over\_time: Optional\[TestTracerouteResultsByColoRoundTripTimeOverTime] time\_period: AggregateTimePeriod Link to this property
values: List\[TestTracerouteResultsByColoRoundTripTimeOverTimeValue] avg\_ms: int Link to this property timestamp: str 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/python/resources/zero_trust/subresources/dex/subresources/tests/subresources/unique_devices/methods/list) zero\_trust.dex.tests.unique\_devices.list(UniqueDeviceListParams\*\*kwargs) -> [UniqueDevices]() GET/accounts/{account\_id}/dex/tests/unique-devices ##### ModelsExpand Collapse
class UniqueDevices: … unique\_devices\_total: int 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/python/resources/zero_trust/subresources/dex/subresources/traceroute_test_results/subresources/network_path/methods/get) zero\_trust.dex.traceroute\_test\_results.network\_path.get(strtest\_result\_id, NetworkPathGetParams\*\*kwargs) -> [NetworkPathGetResponse]() GET/accounts/{account\_id}/dex/traceroute-test-results/{test\_result\_id}/network-path ##### ModelsExpand Collapse
class NetworkPathGetResponse: …
hops: List\[Hop] An array of the hops taken by the device to reach the end destination. ttl: int Link to this property asn: Optional\[int] Link to this property aso: Optional\[str] Link to this property ip\_address: Optional\[str] Link to this property
location: Optional\[HopLocation] city: Optional\[str] Link to this property state: Optional\[str] Link to this property zip: Optional\[str] Link to this property
Link to this property
mile: Optional\[Literal\["client-to-app", "client-to-cf-egress", "client-to-cf-ingress", "client-to-isp"]] 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: Optional\[str] Link to this property packet\_loss\_pct: Optional\[float] formatfloat Link to this property rtt\_ms: Optional\[int] Link to this property
Link to this property result\_id: str API Resource UUID tag. maxLength36 Link to this property colo: Optional\[str] Cloudflare colo airport code. Link to this property device\_name: Optional\[str] Name of the device associated with this network path response. Link to this property
execution\_context: Optional\[Literal\["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 test\_id: Optional\[str] API Resource UUID tag. maxLength36 Link to this property test\_name: Optional\[str] Name of the traceroute test. Link to this property time\_start: Optional\[str] Timestamp indicating when the traceroute test execution began. Link to this property tunnel\_type: Optional\[str] 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/python/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/get) zero\_trust.dex.traceroute\_tests.get(strtest\_id, TracerouteTestGetParams\*\*kwargs) -> [Traceroute]() GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id} ##### [Get percentiles for a traceroute test](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/percentiles) zero\_trust.dex.traceroute\_tests.percentiles(strtest\_id, TracerouteTestPercentilesParams\*\*kwargs) -> [TracerouteTestPercentilesResponse]() GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/percentiles ##### [Get network path breakdown for a traceroute test](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/traceroute_tests/methods/network_path) zero\_trust.dex.traceroute\_tests.network\_path(strtest\_id, TracerouteTestNetworkPathParams\*\*kwargs) -> [NetworkPathResponse]() GET/accounts/{account\_id}/dex/traceroute-tests/{test\_id}/network-path ##### ModelsExpand Collapse
class Traceroute: … host: str The host of the Traceroute synthetic application test. Link to this property interval: str The interval at which the Traceroute synthetic application test is set to run. Link to this property kind: Literal\["traceroute"] Link to this property name: str The name of the Traceroute synthetic application test. Link to this property
target\_policies: Optional\[List\[DigitalExperienceMonitor]] id: str 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: str Link to this property
Link to this property targeted: Optional\[bool] Link to this property
traceroute\_stats: Optional\[TracerouteStats]
availability\_pct: TracerouteStatsAvailabilityPct
slots: List\[TracerouteStatsAvailabilityPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property hops\_count: TestStatOverTime Link to this property
packet\_loss\_pct: TracerouteStatsPacketLossPct
slots: List\[TracerouteStatsPacketLossPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property round\_trip\_time\_ms: TestStatOverTime Link to this property unique\_devices\_total: int Count of unique devices that have run this test in the given time period. Link to this property
Link to this property
traceroute\_stats\_by\_colo: Optional\[List\[TracerouteStatsByColo]]
availability\_pct: TracerouteStatsByColoAvailabilityPct
slots: List\[TracerouteStatsByColoAvailabilityPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property colo: str Link to this property hops\_count: TestStatOverTime Link to this property
packet\_loss\_pct: TracerouteStatsByColoPacketLossPct
slots: List\[TracerouteStatsByColoPacketLossPctSlot] timestamp: str Link to this property value: float formatfloat Link to this property
Link to this property avg: Optional\[float] average observed in the time period. formatfloat Link to this property max: Optional\[float] highest observed in the time period. formatfloat Link to this property min: Optional\[float] lowest observed in the time period. formatfloat Link to this property
Link to this property round\_trip\_time\_ms: TestStatOverTime Link to this property unique\_devices\_total: int 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)>)
class TracerouteTestPercentilesResponse: … hops\_count: Optional\[Percentiles] Link to this property packet\_loss\_pct: Optional\[Percentiles] Link to this property round\_trip\_time\_ms: Optional\[Percentiles] 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/python/resources/zero_trust/subresources/dex/subresources/rules/methods/get) zero\_trust.dex.rules.get(strrule\_id, RuleGetParams\*\*kwargs) -> [RuleGetResponse]() GET/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Delete a DEX Rule](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/rules/methods/delete) zero\_trust.dex.rules.delete(strrule\_id, RuleDeleteParams\*\*kwargs) -> [RuleDeleteResponse]() DELETE/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Update a DEX Rule](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/rules/methods/update) zero\_trust.dex.rules.update(strrule\_id, RuleUpdateParams\*\*kwargs) -> [RuleUpdateResponse]() PATCH/accounts/{account\_id}/dex/rules/{rule\_id} ##### [Create a DEX Rule](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/rules/methods/create) zero\_trust.dex.rules.create(RuleCreateParams\*\*kwargs) -> [RuleCreateResponse]() POST/accounts/{account\_id}/dex/rules ##### [List DEX Rules](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/dex/subresources/rules/methods/list) zero\_trust.dex.rules.list(RuleListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[RuleListResponse]] GET/accounts/{account\_id}/dex/rules ##### ModelsExpand Collapse
class RuleGetResponse: … id: str API Resource UUID tag. maxLength36 Link to this property created\_at: str Link to this property match: str Link to this property name: str Link to this property description: Optional\[str] Link to this property
targeted\_tests: Optional\[List\[TargetedTest]] data: SchemaData The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: bool Link to this property name: str Link to this property test\_id: str Link to this property
Link to this property updated\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>) Optional\[bool] [Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)
class RuleUpdateResponse: … id: str API Resource UUID tag. maxLength36 Link to this property created\_at: str Link to this property match: str Link to this property name: str Link to this property description: Optional\[str] Link to this property
targeted\_tests: Optional\[List\[TargetedTest]] data: SchemaData The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: bool Link to this property name: str Link to this property test\_id: str Link to this property
Link to this property updated\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)>)
class RuleCreateResponse: … id: str API Resource UUID tag. maxLength36 Link to this property created\_at: str Link to this property match: str Link to this property name: str Link to this property description: Optional\[str] Link to this property
targeted\_tests: Optional\[List\[TargetedTest]] data: SchemaData The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: bool Link to this property name: str Link to this property test\_id: str Link to this property
Link to this property updated\_at: Optional\[str] Link to this property
[Link to this property](<#(resource)%20zero_trust.dex.rules%20%3E%20(model)%20rule_create_response%20%3E%20(schema)>)
class RuleListResponse: …
rules: Optional\[List\[Rule]] id: str API Resource UUID tag. maxLength36 Link to this property created\_at: str Link to this property match: str Link to this property name: str Link to this property description: Optional\[str] Link to this property
targeted\_tests: Optional\[List\[RuleTargetedTest]] data: SchemaData The configuration object which contains the details for the WARP client to conduct the test. Link to this property enabled: bool Link to this property name: str Link to this property test\_id: str Link to this property
Link to this property updated\_at: Optional\[str] 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/python/resources/zero_trust/subresources/dex/subresources/devices/subresources/isps/methods/list) zero\_trust.dex.devices.isps.list(strdevice\_id, ISPListParams\*\*kwargs) -> SyncV4PagePagination\[Optional\[ISPs]] GET/accounts/{account\_id}/dex/devices/{device\_id}/isps ##### ModelsExpand Collapse
class ISPs: …
isps: List\[ISP] test\_id: str The test that generated this result. Link to this property test\_result\_id: str The specific test result. Link to this property time\_start: datetime Timestamp of when the ISP was observed. formatdate-time Link to this property
ip: Optional\[ISPIP] 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: Optional\[str] IP address. Returned as "REDACTED" without PII permission. Link to this property asn: Optional\[int] Autonomous System Number. Link to this property aso: Optional\[str] Autonomous System Organization name. Link to this property
location: Optional\[ISPIPLocation] Geographic location information. All fields are returned as the literal string "REDACTED" for callers that do not have the PII permission. city: Optional\[str] City name. Returned as "REDACTED" without PII permission. Link to this property country\_iso: Optional\[str] Country ISO code. Returned as "REDACTED" without PII permission. Link to this property state\_iso: Optional\[str] State/province ISO code. Returned as "REDACTED" without PII permission. Link to this property zip: Optional\[str] ZIP/postal code. Returned as "REDACTED" without PII permission. Link to this property
Link to this property name: Optional\[str] Named IP address (reverse DNS hostname when available). Returned as "REDACTED" without PII permission. Link to this property netmask: Optional\[str] Network mask. Returned as "REDACTED" without PII permission. Link to this property version: Optional\[int] 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)>)