API Reference

Zero Trust

DEX

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fleet Status

List fleet status details by dimension

GET/accounts/{account_id}/dex/fleet-status/live

List fleet status aggregate details by dimension

GET/accounts/{account_id}/dex/fleet-status/over-time

ModelsExpand Collapse

LiveStat object { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

FleetStatusLiveResponse object { deviceStats }

deviceStats: optional object { byColo, byMode, byPlatform, 3 more }

byColo: optional array of LiveStat { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

byMode: optional array of LiveStat { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

byPlatform: optional array of LiveStat { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

byStatus: optional array of LiveStat { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

byVersion: optional array of LiveStat { uniqueDevicesTotal, value }

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

uniqueDevicesTotal: optional number

Number of unique devices

FleetStatusOverTimeResponse object { deviceStats }

deviceStats: optional object { byMode, byStatus, uniqueDevicesTotal }

byMode: optional array of object { timestamp, uniqueDevicesTotal, value }

timestamp: optional string

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

byStatus: optional array of object { timestamp, uniqueDevicesTotal, value }

timestamp: optional string

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

uniqueDevicesTotal: optional number

Number of unique devices

Fleet StatusDevices

List fleet status devices

GET/accounts/{account_id}/dex/fleet-status/devices

ModelsExpand Collapse

DeviceListResponse object { 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: optional boolean

batteryCharging: optional boolean

batteryCycles: optional number

formatint64

batteryPct: optional number

formatfloat

connectionType: optional string

cpuPct: optional number

formatfloat

cpuPctByApp: optional array of object { cpu_pct, name }

cpu_pct: optional number

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

formatfloat

maximum100

minimum0

name: optional string

Application name.

deviceIpv4: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

deviceIpv6: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

deviceName: optional string

Device identifier (human readable).

DeprecateddeviceRegistration: optional string

Use `registrationId` instead.

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

diskReadBps: optional number

formatint64

diskUsagePct: optional number

formatfloat

diskWriteBps: optional number

formatint64

dohSubdomain: optional string

estimatedLossPct: optional number

formatfloat

firewallEnabled: optional boolean

gatewayIpv4: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

gatewayIpv6: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

handshakeLatencyMs: optional number

formatint64

ispIpv4: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

ispIpv6: optional object { address, asn, aso, 4 more }

address: optional string

asn: optional number

aso: optional string

location: optional object { city, country_iso, state_iso, zip }

city: optional string

country_iso: optional string

state_iso: optional string

zip: optional string

name: optional string

netmask: optional string

version: optional number

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

metal: optional string

networkRcvdBps: optional number

formatint64

networkSentBps: optional number

formatint64

networkSsid: optional string

personEmail: optional string

User contact email address

ramAvailableKb: optional number

formatint64

ramUsedPct: optional number

formatfloat

ramUsedPctByApp: optional array of object { name, ram_used_pct }

name: optional string

Application name.

ram_used_pct: optional number

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

formatfloat

maximum100

minimum0

registrationId: optional string

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

rtt: optional object { minRttUs, rttUs, rttVarUs }

Round-trip time statistics for the WARP tunnel.

minRttUs: optional object { downstream, upstream }

Minimum round-trip time in microseconds.

downstream: optional number

upstream: optional number

rttUs: optional object { downstream, upstream }

Round-trip time in microseconds.

downstream: optional number

upstream: optional number

rttVarUs: optional object { downstream, upstream }

Round-trip time variance in microseconds.

downstream: optional number

upstream: optional number

switchLocked: optional boolean

tunnelStats: optional object { bytesLost, bytesReceived, bytesRetransmitted, 6 more }

WARP tunnel packet and byte counters.

bytesLost: optional object { downstream, upstream }

Number of bytes lost, split by direction.

downstream: optional number

upstream: optional number

bytesReceived: optional object { downstream, upstream }

Number of bytes received, split by direction.

downstream: optional number

upstream: optional number

bytesRetransmitted: optional object { downstream, upstream }

Number of bytes retransmitted, split by direction.

downstream: optional number

upstream: optional number

bytesSent: optional object { downstream, upstream }

Number of bytes sent, split by direction.

downstream: optional number

upstream: optional number

packetsLost: optional object { downstream, upstream }

Number of packets lost, split by direction.

downstream: optional number

upstream: optional number

packetsReceived: optional object { downstream, upstream }

Number of packets received, split by direction.

downstream: optional number

upstream: optional number

packetsRetransmitted: optional object { downstream, upstream }

Number of packets retransmitted, split by direction.

downstream: optional number

upstream: optional number

packetsSent: optional object { downstream, upstream }

Number of packets sent, split by direction.

downstream: optional number

upstream: optional number

statsWindowMs: optional number

The measurement window duration in milliseconds.

tunnelType: optional string

wifiStrengthDbm: optional number

formatint64