Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DEX

Fleet Status

Get live aggregate device 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
Get over time aggregate details for devices 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

Fleet StatusDevices

List details of devices using WARP.
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