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

Fleet 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

Timestamp in ISO format

uniqueDevicesTotal?: number

Number of unique devices

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

Timestamp in ISO format

uniqueDevicesTotal?: number

Number of unique devices

value?: string
uniqueDevicesTotal?: number

Number of unique devices

Fleet 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, 36 more } >
GET/accounts/{account_id}/dex/fleet-status/devices
ModelsExpand Collapse
DeviceListResponse { colo, deviceId, mode, 36 more }
colo: string

Cloudflare colo

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

Timestamp in ISO format

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<Array<CPUPctByApp>> | null
cpu_pct?: number
formatfloat
name?: string
deviceIpv4?: DeviceIPV4 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
deviceIpv6?: DeviceIPV6 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
deviceName?: string

Device identifier (human readable)

diskReadBps?: number | null
formatint64
diskUsagePct?: number | null
formatfloat
diskWriteBps?: number | null
formatint64
dohSubdomain?: string | null
estimatedLossPct?: number | null
formatfloat
firewallEnabled?: boolean | null
gatewayIpv4?: GatewayIPV4 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
gatewayIpv6?: GatewayIPV6 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
handshakeLatencyMs?: number | null
formatint64
ispIpv4?: ISPIPV4 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
ispIpv6?: ISPIPV6 { address, asn, aso, 3 more }
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
netmask?: string | null
version?: string | null
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<Array<RamUsedPctByApp>> | null
name?: string
ram_used_pct?: number
formatfloat
registrationId?: string | null

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

switchLocked?: boolean | null
wifiStrengthDbm?: number | null
formatint64