Skip to content
Cloudflare API
Start here
API Reference
Zero Trust

DEX

ModelsExpand Collapse
DigitalExperienceMonitor { id, default, name }
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account.

name: string
NetworkPath { slots, sampling }
slots: Array<Slot>
id: string

API Resource UUID tag.

maxLength36
clientToAppRttMs: number | null

Round trip time in ms of the client to app mile

clientToCfEgressRttMs: number | null

Round trip time in ms of the client to Cloudflare egress mile

clientToCfIngressRttMs: number | null

Round trip time in ms of the client to Cloudflare ingress mile

timestamp: string
clientToIspRttMs?: number | null

Round trip time in ms of the client to ISP mile

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"
value: number
NetworkPathResponse { id, deviceName, interval, 4 more }
id: string

API Resource UUID tag.

maxLength36
deviceName?: string

Name of the device that ran the test.

interval?: string

The interval at which the Traceroute synthetic application test is set to run.

kind?: "traceroute"
name?: string
networkPath?: NetworkPath { slots, sampling } | null
url?: string

The host of the Traceroute synthetic application test.

Percentiles { p50, p90, p95, p99 }
p50?: number | null

p50 observed in the time period.

p90?: number | null

p90 observed in the time period.

p95?: number | null

p95 observed in the time period.

p99?: number | null

p99 observed in the time period.

DEXWARP Change Events

List WARP change events.
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.

account_tag?: string

The public account identifier.

device_id?: string

The device ID.

maxLength36
Deprecateddevice_registration?: string

Use registration_id instead.

Deprecated: use registration_id. The device registration ID.

maxLength36
hostname?: string

The hostname of the machine the event is from.

registration_id?: string

The device registration ID.

maxLength36
serial_number?: string

The serial number of the machine the event is from.

timestamp?: string

The event time.

formatdate-time
toggle?: "on" | "off"

The state of the WARP toggle.

One of the following:
"on"
"off"
user_email?: string

Email tied to the device.

DigitalExperienceMonitoringWARPConfigChangeEvent { device_id, device_registration, from, 6 more }
device_id?: string

The device ID.

maxLength36
Deprecateddevice_registration?: string

Use registration_id instead.

Deprecated: use registration_id. The device registration ID.

maxLength36
from?: From { account_name, account_tag, config_name }

The details for the WARP configuration that was switched from.

account_name?: string

The account name.

account_tag?: string

The public account identifier.

maxLength36
config_name?: string

The name of the WARP configuration.

hostname?: string

The hostname of the machine the event is from.

registration_id?: string

The device registration ID.

maxLength36
serial_number?: string

The serial number of the machine the event is from.

timestamp?: string

The event time.

formatdate-time
to?: To { account_name, account_tag, config_name }

The details for the WARP configuration that was switched to.

account_name?: string

The account name.

account_tag?: string

The public account identifier.

maxLength36
config_name?: string

The name of the WARP configuration.

user_email?: string

Email tied to the device.

DEXCommands

List account commands
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
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
completed_date?: string | null
formatdate-time
created_date?: string
formatdate-time
device_id?: string
filename?: string | null
registration_id?: string

Unique identifier for the device registration

status?: string
type?: string
user_email?: string
CommandCreateResponse { commands }
commands?: Array<Command>

List of created commands

id?: string

Unique identifier for the command

args?: Record<string, string>

Command arguments

device_id?: string

Identifier for the device associated with the command

registration_id?: string

Unique identifier for the device registration

status?: "PENDING_EXEC" | "PENDING_UPLOAD" | "SUCCESS" | "FAILED"

Current status of the command

One of the following:
"PENDING_EXEC"
"PENDING_UPLOAD"
"SUCCESS"
"FAILED"
type?: string

Type of the command (e.g., “pcap”, “speed-test”, or “warp-diag”)

DEXCommandsDevices

List devices eligible for remote captures
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)

deviceName?: string

Device identifier (human readable)

eligible?: boolean

Whether the device is eligible for remote captures

ineligibleReason?: string

If the device is not eligible, the reason why.

personEmail?: string

User contact email address

platform?: string

Operating system.

registrationId?: string

Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device.

status?: string

Network status.

timestamp?: string
version?: string

WARP client version.

DEXCommandsDownloads

Download command output file
client.zeroTrust.dex.commands.downloads.get(stringcommandId, stringfilename, DownloadGetParams { account_id } params, RequestOptionsoptions?): Response
GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

DEXCommandsQuota

Returns account commands usage, quota, and reset time
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.

quota_usage: number

The number of commands that have been initiated for an account.

reset_time: string

The time when the quota resets.

formatdate-time

DEXColos

List Cloudflare colos
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

city: string

City

countryCode: string

Country code

DEXFleet Status

List fleet status details by dimension
client.zeroTrust.dex.fleetStatus.live(FleetStatusLiveParams { account_id, since_minutes } params, RequestOptionsoptions?): FleetStatusLiveResponse { deviceStats }
GET/accounts/{account_id}/dex/fleet-status/live
List fleet status aggregate details by dimension
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

value?: string
FleetStatusLiveResponse { deviceStats }
deviceStats?: DeviceStats { byColo, byMode, byPlatform, 3 more }
byColo?: Array<LiveStat { uniqueDevicesTotal, value } > | null
uniqueDevicesTotal?: number

Number of unique devices

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

Number of unique devices

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

Number of unique devices

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

Number of unique devices

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

Number of unique devices

value?: string
uniqueDevicesTotal?: number

Number of unique devices

FleetStatusOverTimeResponse { deviceStats }
deviceStats?: DeviceStats { byMode, byStatus, uniqueDevicesTotal }
byMode?: Array<ByMode>
timestamp?: string
uniqueDevicesTotal?: number

Number of unique devices

value?: string
byStatus?: Array<ByStatus>
timestamp?: string
uniqueDevicesTotal?: number

Number of unique devices

value?: string
uniqueDevicesTotal?: number

Number of unique devices

DEXFleet StatusDevices

List fleet status devices
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.

deviceId: string

Device identifier (UUID v4)

mode: string

The mode under which the WARP client is run.

platform: string

Operating system.

status: string

Network status.

timestamp: string
version: string

WARP client version.

alwaysOn?: boolean | null
batteryCharging?: boolean | null
batteryCycles?: number | null
formatint64
batteryPct?: number | null
formatfloat
connectionType?: string | null
cpuPct?: number | null
formatfloat
cpuPctByApp?: Array<CPUPctByApp> | null
cpu_pct?: number | null

CPU usage percentage, on a scale of 0 to 100.

formatfloat
maximum100
minimum0
name?: string | null

Application name.

deviceIpv4?: DeviceIPV4 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

deviceIpv6?: DeviceIPV6 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

deviceName?: string

Device identifier (human readable).

DeprecateddeviceRegistration?: string | null

Use registrationId instead.

Deprecated: use registrationId. Device registration identifier (UUID).

diskReadBps?: number | null
formatint64
diskUsagePct?: number | null
formatfloat
diskWriteBps?: number | null
formatint64
dohSubdomain?: string | null
estimatedLossPct?: number | null
formatfloat
firewallEnabled?: boolean | null
gatewayIpv4?: GatewayIPV4 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

gatewayIpv6?: GatewayIPV6 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

handshakeLatencyMs?: number | null
formatint64
ispIpv4?: ISPIPV4 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

ispIpv6?: ISPIPV6 | null
address?: string | null
asn?: number | null
aso?: string | null
location?: Location { city, country_iso, state_iso, zip }
city?: string | null
country_iso?: string | null
state_iso?: string | null
zip?: string | null
name?: string | null
netmask?: string | null
version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

metal?: string | null
networkRcvdBps?: number | null
formatint64
networkSentBps?: number | null
formatint64
networkSsid?: string | null
personEmail?: string

User contact email address

ramAvailableKb?: number | null
formatint64
ramUsedPct?: number | null
formatfloat
ramUsedPctByApp?: Array<RamUsedPctByApp> | null
name?: string | null

Application name.

ram_used_pct?: number | null

RAM usage percentage, on a scale of 0 to 100.

formatfloat
maximum100
minimum0
registrationId?: string | null

Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user’s registration on the device.

rtt?: RTT | null

Round-trip time statistics for the WARP tunnel.

minRttUs?: MinRTTUs | null

Minimum round-trip time in microseconds.

downstream?: number | null
upstream?: number | null
rttUs?: RTTUs | null

Round-trip time in microseconds.

downstream?: number | null
upstream?: number | null
rttVarUs?: RTTVarUs | null

Round-trip time variance in microseconds.

downstream?: number | null
upstream?: number | null
switchLocked?: boolean | null
tunnelStats?: TunnelStats | null

WARP tunnel packet and byte counters.

bytesLost?: BytesLost | null

Number of bytes lost, split by direction.

downstream?: number | null
upstream?: number | null
bytesReceived?: BytesReceived | null

Number of bytes received, split by direction.

downstream?: number | null
upstream?: number | null
bytesRetransmitted?: BytesRetransmitted | null

Number of bytes retransmitted, split by direction.

downstream?: number | null
upstream?: number | null
bytesSent?: BytesSent | null

Number of bytes sent, split by direction.

downstream?: number | null
upstream?: number | null
packetsLost?: PacketsLost | null

Number of packets lost, split by direction.

downstream?: number | null
upstream?: number | null
packetsReceived?: PacketsReceived | null

Number of packets received, split by direction.

downstream?: number | null
upstream?: number | null
packetsRetransmitted?: PacketsRetransmitted | null

Number of packets retransmitted, split by direction.

downstream?: number | null
upstream?: number | null
packetsSent?: PacketsSent | null

Number of packets sent, split by direction.

downstream?: number | null
upstream?: number | null
statsWindowMs?: number | null

The measurement window duration in milliseconds.

tunnelType?: string | null
wifiStrengthDbm?: number | null
formatint64

DEXHTTP Tests

Get details and aggregate metrics for an http test
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.

httpStats?: HTTPStats | null
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
dnsResponseTimeMs: TestStatOverTime { slots, avg, max, min }
httpStatusCode: Array<HTTPStatusCode>
status200: number
status300: number
status400: number
status500: number
timestamp: string
resourceFetchTimeMs: TestStatOverTime { slots, avg, max, min }
serverResponseTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

httpStatsByColo?: Array<HTTPStatsByColo>
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
colo: string
dnsResponseTimeMs: TestStatOverTime { slots, avg, max, min }
httpStatusCode: Array<HTTPStatusCode>
status200: number
status300: number
status400: number
status500: number
timestamp: string
resourceFetchTimeMs: TestStatOverTime { slots, avg, max, min }
serverResponseTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

interval?: string

The interval at which the HTTP synthetic application test is set to run.

kind?: "http"
method?: string

The HTTP method to use when running the test.

name?: string

The name of the HTTP synthetic application test.

target_policies?: Array<DigitalExperienceMonitor { id, default, name } > | null
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account.

name: string
targeted?: boolean

DEXHTTP TestsPercentiles

Get percentiles for an http test
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 }
resourceFetchTimeMs?: Percentiles { p50, p90, p95, p99 }
serverResponseTimeMs?: Percentiles { p50, p90, p95, p99 }
TestStatOverTime { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
avg?: number | null

average observed in the time period.

max?: number | null

highest observed in the time period.

min?: number | null

lowest observed in the time period.

DEXTests

List DEX test analytics
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"
"days"
"testRuns"
value: number
Tests { overviewMetrics, tests }
overviewMetrics: OverviewMetrics { testsTotal, avgHttpAvailabilityPct, avgTracerouteAvailabilityPct }
testsTotal: number

number of tests.

avgHttpAvailabilityPct?: number | null

percentage availability for all HTTP test results in response.

formatfloat
avgTracerouteAvailabilityPct?: number | null

percentage availability for all traceroutes results in response.

formatfloat
tests: Array<Test>

array of test results objects.

id: string

API Resource UUID tag.

maxLength36
created: string

date the test was created.

description: string

the test description defined during configuration

enabled: boolean

if true, then the test will run on targeted devices. Else, the test will not run.

host: string
interval: string

The interval at which the synthetic application test is set to run.

kind: "http" | "traceroute"

test type, http or traceroute

One of the following:
"http"
"traceroute"
name: string

name given to this test

updated: string
httpResults?: HTTPResults | null
resourceFetchTime: ResourceFetchTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
httpResultsByColo?: Array<HTTPResultsByColo>
colo: string

Cloudflare colo

resourceFetchTime: ResourceFetchTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
method?: string

for HTTP, the method to use when running the test

target_policies?: Array<DigitalExperienceMonitor { id, default, name } > | null
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account.

name: string
targeted?: boolean
tracerouteResults?: TracerouteResults | null
roundTripTime: RoundTripTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string
tracerouteResultsByColo?: Array<TracerouteResultsByColo>
colo: string

Cloudflare colo

roundTripTime: RoundTripTime { history, avgMs, overTime }
history: Array<History>
timePeriod: AggregateTimePeriod { units, value }
avgMs?: number | null
deltaPct?: number | null
formatfloat
avgMs?: number | null
overTime?: OverTime | null
timePeriod: AggregateTimePeriod { units, value }
values: Array<Value>
avgMs: number
timestamp: string

DEXTestsUnique Devices

Get count of devices targeted
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

DEXTraceroute Test Results

DEXTraceroute Test ResultsNetwork Path

Get details for a specific traceroute test run
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
asn?: number | null
aso?: string | null
ipAddress?: string | null
location?: Location | null
city?: string | null
state?: string | null
zip?: string | null
mile?: "client-to-app" | "client-to-cf-egress" | "client-to-cf-ingress" | "client-to-isp" | null
One of the following:
"client-to-app"
"client-to-cf-egress"
"client-to-cf-ingress"
"client-to-isp"
name?: string | null
packetLossPct?: number | null
formatfloat
rttMs?: number | null
resultId: string

API Resource UUID tag.

maxLength36
colo?: string

Cloudflare colo airport code.

deviceName?: string

Name of the device associated with this network path response.

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"
"OUT_OF_TUNNEL"
"IN_TUNNEL"
testId?: string

API Resource UUID tag.

maxLength36
testName?: string

Name of the traceroute test.

time_start?: string

Timestamp indicating when the traceroute test execution began.

tunnel_type?: string | null

DEXTraceroute Tests

Get details and aggregate metrics for a traceroute test
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
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
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.

interval: string

The interval at which the Traceroute synthetic application test is set to run.

kind: "traceroute"
name: string

The name of the Traceroute synthetic application test.

target_policies?: Array<DigitalExperienceMonitor { id, default, name } > | null
id: string

API Resource UUID tag.

maxLength36
default: boolean

Whether the policy is the default for the account.

name: string
targeted?: boolean
tracerouteStats?: TracerouteStats | null
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
hopsCount: TestStatOverTime { slots, avg, max, min }
packetLossPct: PacketLossPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
roundTripTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

tracerouteStatsByColo?: Array<TracerouteStatsByColo>
availabilityPct: AvailabilityPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
colo: string
hopsCount: TestStatOverTime { slots, avg, max, min }
packetLossPct: PacketLossPct { slots, avg, max, min }
slots: Array<Slot>
timestamp: string
value: number
formatfloat
avg?: number | null

average observed in the time period.

formatfloat
max?: number | null

highest observed in the time period.

formatfloat
min?: number | null

lowest observed in the time period.

formatfloat
roundTripTimeMs: TestStatOverTime { slots, avg, max, min }
uniqueDevicesTotal: number

Count of unique devices that have run this test in the given time period.

TracerouteTestPercentilesResponse { hopsCount, packetLossPct, roundTripTimeMs }
hopsCount?: Percentiles { p50, p90, p95, p99 }
packetLossPct?: Percentiles { p50, p90, p95, p99 }
roundTripTimeMs?: Percentiles { p50, p90, p95, p99 }

DEXRules

Get DEX Rule
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
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
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
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
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
created_at: string
match: string
name: string
description?: string
targeted_tests?: Array<TargetedTest>
data: Data { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

host: string

The desired endpoint to test.

kind: "http" | "traceroute"

The type of test.

One of the following:
"http"
"traceroute"
method?: "GET"

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at?: string
RuleDeleteResponse = boolean | null
RuleUpdateResponse { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description?: string
targeted_tests?: Array<TargetedTest>
data: Data { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

host: string

The desired endpoint to test.

kind: "http" | "traceroute"

The type of test.

One of the following:
"http"
"traceroute"
method?: "GET"

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at?: string
RuleCreateResponse { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description?: string
targeted_tests?: Array<TargetedTest>
data: Data { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

host: string

The desired endpoint to test.

kind: "http" | "traceroute"

The type of test.

One of the following:
"http"
"traceroute"
method?: "GET"

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at?: string
RuleListResponse { rules }
rules?: Array<Rule>
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description?: string
targeted_tests?: Array<TargetedTest>
data: Data { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

host: string

The desired endpoint to test.

kind: "http" | "traceroute"

The type of test.

One of the following:
"http"
"traceroute"
method?: "GET"

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at?: string

DEXDevices

DEXDevicesISPs

List device ISPs
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.

test_result_id: string

The specific test result.

time_start: string

Timestamp of when the ISP was observed.

formatdate-time
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.

asn?: number

Autonomous System Number.

aso?: string

Autonomous System Organization name.

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.

country_iso?: string

Country ISO code. Returned as "REDACTED" without PII permission.

state_iso?: string

State/province ISO code. Returned as "REDACTED" without PII permission.

zip?: string

ZIP/postal code. Returned as "REDACTED" without PII permission.

name?: string

Named IP address (reverse DNS hostname when available). Returned as "REDACTED" without PII permission.

netmask?: string

Network mask. Returned as "REDACTED" without PII permission.

version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).