Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DEX
Fleet Status
Devices

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

List details for devices using WARP.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Cloudflare DEX WriteCloudflare DEX ReadZero Trust ReportZero Trust Read
ParametersExpand Collapse
params: DeviceListParams { account_id, from, page, 10 more }
account_id: string

Path param: Unique identifier linked to an account.

maxLength32
from: string

Query param: Start of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch.

page: number

Query param: Page number of paginated results.

minimum1
per_page: number

Query param: Number of results per page.

maximum50
minimum1
to: string

Query param: End of the time range to query. Timestamp can be provided in ISO 8601 datetime format or milliseconds since epoch.

colo?: string

Query param: Cloudflare colo airport code.

device_id?: string

Query param: Device-specific ID, given as UUID.

mode?: string

Query param: The mode under which the WARP client is run.

platform?: string

Query param: Operating system.

sort_by?: "colo" | "device_id" | "mode" | 4 more

Query param: Dimension to sort results by.

One of the following:
"colo"
"device_id"
"mode"
"platform"
"status"
"timestamp"
"version"
source?: "last_seen" | "hourly" | "raw"

Query param: Source:

  • hourly - device details aggregated hourly, up to 7 days prior
  • last_seen - device details, up to 60 minutes prior. Time windows exceeding 60 minutes will be rejected from June 1st, 2026. Please use ‘hourly’ or ‘raw’ instead for longer time ranges.
  • raw - device details, up to 7 days prior
One of the following:
"last_seen"
"hourly"
"raw"
status?: string

Query param: Network status.

version?: string

Query param: WARP client version.

ReturnsExpand 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

List fleet status devices

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const deviceListResponse of client.zeroTrust.dex.fleetStatus.devices.list({
  account_id: '01a7362d577a6c3019a474fd6f485823',
  from: '2023-10-11 00:00:00+00',
  page: 1,
  per_page: 10,
  to: '2023-10-11 00:00:00+00',
})) {
  console.log(deviceListResponse.networkSsid);
}
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "colo": "SJC",
      "deviceId": "deviceId",
      "mode": "proxy",
      "platform": "windows",
      "status": "connected",
      "timestamp": "2023-10-11 00:00:00+00",
      "version": "1.0.0",
      "alwaysOn": true,
      "batteryCharging": true,
      "batteryCycles": 0,
      "batteryPct": 0,
      "connectionType": "connectionType",
      "cpuPct": 0,
      "cpuPctByApp": [
        {
          "cpu_pct": 0,
          "name": "name"
        }
      ],
      "deviceIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "deviceIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "deviceName": "deviceName",
      "deviceRegistration": "deviceRegistration",
      "diskReadBps": 0,
      "diskUsagePct": 0,
      "diskWriteBps": 0,
      "dohSubdomain": "dohSubdomain",
      "estimatedLossPct": 0,
      "firewallEnabled": true,
      "gatewayIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "gatewayIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "handshakeLatencyMs": 0,
      "ispIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "ispIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "metal": "metal",
      "networkRcvdBps": 0,
      "networkSentBps": 0,
      "networkSsid": "networkSsid",
      "personEmail": "personEmail",
      "ramAvailableKb": 0,
      "ramUsedPct": 0,
      "ramUsedPctByApp": [
        {
          "name": "name",
          "ram_used_pct": 0
        }
      ],
      "registrationId": "registrationId",
      "rtt": {
        "minRttUs": {
          "downstream": 0,
          "upstream": 0
        },
        "rttUs": {
          "downstream": 0,
          "upstream": 0
        },
        "rttVarUs": {
          "downstream": 0,
          "upstream": 0
        }
      },
      "switchLocked": true,
      "tunnelStats": {
        "bytesLost": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesReceived": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesRetransmitted": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesSent": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsLost": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsReceived": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsRetransmitted": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsSent": {
          "downstream": 0,
          "upstream": 0
        },
        "statsWindowMs": 0
      },
      "tunnelType": "tunnelType",
      "wifiStrengthDbm": 0
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "colo": "SJC",
      "deviceId": "deviceId",
      "mode": "proxy",
      "platform": "windows",
      "status": "connected",
      "timestamp": "2023-10-11 00:00:00+00",
      "version": "1.0.0",
      "alwaysOn": true,
      "batteryCharging": true,
      "batteryCycles": 0,
      "batteryPct": 0,
      "connectionType": "connectionType",
      "cpuPct": 0,
      "cpuPctByApp": [
        {
          "cpu_pct": 0,
          "name": "name"
        }
      ],
      "deviceIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "deviceIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "deviceName": "deviceName",
      "deviceRegistration": "deviceRegistration",
      "diskReadBps": 0,
      "diskUsagePct": 0,
      "diskWriteBps": 0,
      "dohSubdomain": "dohSubdomain",
      "estimatedLossPct": 0,
      "firewallEnabled": true,
      "gatewayIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "gatewayIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "handshakeLatencyMs": 0,
      "ispIpv4": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "ispIpv6": {
        "address": "address",
        "asn": 0,
        "aso": "aso",
        "location": {
          "city": "city",
          "country_iso": "country_iso",
          "state_iso": "state_iso",
          "zip": "zip"
        },
        "name": "name",
        "netmask": "netmask",
        "version": 1
      },
      "metal": "metal",
      "networkRcvdBps": 0,
      "networkSentBps": 0,
      "networkSsid": "networkSsid",
      "personEmail": "personEmail",
      "ramAvailableKb": 0,
      "ramUsedPct": 0,
      "ramUsedPctByApp": [
        {
          "name": "name",
          "ram_used_pct": 0
        }
      ],
      "registrationId": "registrationId",
      "rtt": {
        "minRttUs": {
          "downstream": 0,
          "upstream": 0
        },
        "rttUs": {
          "downstream": 0,
          "upstream": 0
        },
        "rttVarUs": {
          "downstream": 0,
          "upstream": 0
        }
      },
      "switchLocked": true,
      "tunnelStats": {
        "bytesLost": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesReceived": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesRetransmitted": {
          "downstream": 0,
          "upstream": 0
        },
        "bytesSent": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsLost": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsReceived": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsRetransmitted": {
          "downstream": 0,
          "upstream": 0
        },
        "packetsSent": {
          "downstream": 0,
          "upstream": 0
        },
        "statsWindowMs": 0
      },
      "tunnelType": "tunnelType",
      "wifiStrengthDbm": 0
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}