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

Timestamp in ISO format

uniqueDevicesTotal: optional number

Number of unique devices

value: optional string

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

timestamp: optional string

Timestamp in ISO format

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, 37 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: optional boolean

batteryCharging: optional boolean

batteryCycles: optional number

formatint64

batteryPct: optional number

formatfloat

connectionType: optional string

cpuPct: optional number

formatfloat

cpuPctByApp: optional array of array of object { cpu_pct, name }

cpu_pct: optional number

formatfloat

name: optional string

deviceIpv4: optional object { address, asn, aso, 3 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

netmask: optional string

version: optional string

deviceIpv6: optional object { address, asn, aso, 3 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

netmask: optional string

version: optional string

deviceName: optional string

Device identifier (human readable)

DeprecateddeviceRegistration: optional string

Use `registrationId` instead.

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

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, 3 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

netmask: optional string

version: optional string

gatewayIpv6: optional object { address, asn, aso, 3 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

netmask: optional string

version: optional string

handshakeLatencyMs: optional number

formatint64

ispIpv4: optional object { address, asn, aso, 3 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

netmask: optional string

version: optional string

ispIpv6: optional object { address, asn, aso, 3 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

netmask: optional string

version: optional string

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 array of object { name, ram_used_pct }

name: optional string

ram_used_pct: optional number

formatfloat

registrationId: optional string

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

switchLocked: optional boolean

wifiStrengthDbm: optional number

formatint64