Skip to content
Start here

List fleet status devices

client.ZeroTrust.DEX.FleetStatus.Devices.List(ctx, params) (*V4PagePaginationArray[DEXFleetStatusDeviceListResponse], error)
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 DEXFleetStatusDeviceListParams
AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32
From param.Field[string]

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

Page param.Field[float64]

Query param: Page number of paginated results.

minimum1
PerPage param.Field[float64]

Query param: Number of results per page.

maximum50
minimum1
To param.Field[string]

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

Colo param.Field[string]Optional

Query param: Cloudflare colo airport code.

DeviceID param.Field[string]Optional

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

Mode param.Field[string]Optional

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

Platform param.Field[string]Optional

Query param: Operating system.

SortBy param.Field[DEXFleetStatusDeviceListParamsSortBy]Optional

Query param: Dimension to sort results by.

const DEXFleetStatusDeviceListParamsSortByColo DEXFleetStatusDeviceListParamsSortBy = "colo"
const DEXFleetStatusDeviceListParamsSortByDeviceID DEXFleetStatusDeviceListParamsSortBy = "device_id"
const DEXFleetStatusDeviceListParamsSortByMode DEXFleetStatusDeviceListParamsSortBy = "mode"
const DEXFleetStatusDeviceListParamsSortByPlatform DEXFleetStatusDeviceListParamsSortBy = "platform"
const DEXFleetStatusDeviceListParamsSortByStatus DEXFleetStatusDeviceListParamsSortBy = "status"
const DEXFleetStatusDeviceListParamsSortByTimestamp DEXFleetStatusDeviceListParamsSortBy = "timestamp"
const DEXFleetStatusDeviceListParamsSortByVersion DEXFleetStatusDeviceListParamsSortBy = "version"
Source param.Field[DEXFleetStatusDeviceListParamsSource]Optional

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
const DEXFleetStatusDeviceListParamsSourceLastSeen DEXFleetStatusDeviceListParamsSource = "last_seen"
const DEXFleetStatusDeviceListParamsSourceHourly DEXFleetStatusDeviceListParamsSource = "hourly"
const DEXFleetStatusDeviceListParamsSourceRaw DEXFleetStatusDeviceListParamsSource = "raw"
Status param.Field[string]Optional

Query param: Network status.

Version param.Field[string]Optional

Query param: WARP client version.

ReturnsExpand Collapse
type DEXFleetStatusDeviceListResponse struct{…}
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 boolOptional
BatteryCharging boolOptional
BatteryCycles int64Optional
formatint64
BatteryPct float64Optional
formatfloat
ConnectionType stringOptional
CPUPct float64Optional
formatfloat
CPUPctByApp []DEXFleetStatusDeviceListResponseCPUPctByAppOptional
CPUPct float64Optional

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

formatfloat
maximum100
minimum0
Name stringOptional

Application name.

DeviceIPV4 DEXFleetStatusDeviceListResponseDeviceIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseDeviceIPV4LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

DeviceIPV6 DEXFleetStatusDeviceListResponseDeviceIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseDeviceIPV6LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

DeviceName stringOptional

Device identifier (human readable).

DeprecatedDeviceRegistration stringOptional

Use registrationId instead.

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

DiskReadBps int64Optional
formatint64
DiskUsagePct float64Optional
formatfloat
DiskWriteBps int64Optional
formatint64
DOHSubdomain stringOptional
EstimatedLossPct float64Optional
formatfloat
FirewallEnabled boolOptional
GatewayIPV4 DEXFleetStatusDeviceListResponseGatewayIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseGatewayIPV4LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

GatewayIPV6 DEXFleetStatusDeviceListResponseGatewayIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseGatewayIPV6LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

HandshakeLatencyMs float64Optional
formatint64
ISPIPV4 DEXFleetStatusDeviceListResponseISPIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseISPIPV4LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

ISPIPV6 DEXFleetStatusDeviceListResponseISPIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DEXFleetStatusDeviceListResponseISPIPV6LocationOptional
City stringOptional
CountryISO stringOptional
StateISO stringOptional
Zip stringOptional
Name stringOptional
Netmask stringOptional
Version int64Optional

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

Metal stringOptional
NetworkRcvdBps int64Optional
formatint64
NetworkSentBps int64Optional
formatint64
NetworkSsid stringOptional
PersonEmail stringOptional

User contact email address

RamAvailableKB int64Optional
formatint64
RamUsedPct float64Optional
formatfloat
RamUsedPctByApp []DEXFleetStatusDeviceListResponseRamUsedPctByAppOptional
Name stringOptional

Application name.

RamUsedPct float64Optional

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

formatfloat
maximum100
minimum0
RegistrationID stringOptional

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

RTT DEXFleetStatusDeviceListResponseRTTOptional

Round-trip time statistics for the WARP tunnel.

MinRTTUs DEXFleetStatusDeviceListResponseRTTMinRTTUsOptional

Minimum round-trip time in microseconds.

Downstream int64Optional
Upstream int64Optional
RTTUs DEXFleetStatusDeviceListResponseRTTRTTUsOptional

Round-trip time in microseconds.

Downstream int64Optional
Upstream int64Optional
RTTVarUs DEXFleetStatusDeviceListResponseRTTRTTVarUsOptional

Round-trip time variance in microseconds.

Downstream int64Optional
Upstream int64Optional
SwitchLocked boolOptional
TunnelStats DEXFleetStatusDeviceListResponseTunnelStatsOptional

WARP tunnel packet and byte counters.

BytesLost DEXFleetStatusDeviceListResponseTunnelStatsBytesLostOptional

Number of bytes lost, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesReceived DEXFleetStatusDeviceListResponseTunnelStatsBytesReceivedOptional

Number of bytes received, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesRetransmitted DEXFleetStatusDeviceListResponseTunnelStatsBytesRetransmittedOptional

Number of bytes retransmitted, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesSent DEXFleetStatusDeviceListResponseTunnelStatsBytesSentOptional

Number of bytes sent, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsLost DEXFleetStatusDeviceListResponseTunnelStatsPacketsLostOptional

Number of packets lost, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsReceived DEXFleetStatusDeviceListResponseTunnelStatsPacketsReceivedOptional

Number of packets received, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsRetransmitted DEXFleetStatusDeviceListResponseTunnelStatsPacketsRetransmittedOptional

Number of packets retransmitted, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsSent DEXFleetStatusDeviceListResponseTunnelStatsPacketsSentOptional

Number of packets sent, split by direction.

Downstream int64Optional
Upstream int64Optional
StatsWindowMs int64Optional

The measurement window duration in milliseconds.

TunnelType stringOptional
WifiStrengthDbm int64Optional
formatint64

List fleet status devices

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.ZeroTrust.DEX.FleetStatus.Devices.List(context.TODO(), zero_trust.DEXFleetStatusDeviceListParams{
    AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
    From: cloudflare.F("2023-10-11 00:00:00+00"),
    Page: cloudflare.F(1.000000),
    PerPage: cloudflare.F(10.000000),
    To: cloudflare.F("2023-10-11 00:00:00+00"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "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
  }
}