Skip to main content

fleet_status_devices

Creates, updates, deletes, gets or lists a fleet_status_devices resource.

Overview

Namefleet_status_devices
TypeResource
Idcloudflare.zero_trust.fleet_status_devices

Fields

The following fields are returned by SELECT queries:

List devices response

NameDatatypeDescription
alwaysOnboolean
batteryChargingboolean
batteryCyclesinteger (int64)
batteryPctnumber (float)
colostringCloudflare colo (example: SJC)
connectionTypestring
cpuPctnumber (float)
cpuPctByApparray
deviceIdstringDevice identifier (UUID v4)
deviceIpv4object
deviceIpv6object
deviceNamestringDevice identifier (human readable)
diskReadBpsinteger (int64)
diskUsagePctnumber (float)
diskWriteBpsinteger (int64)
dohSubdomainstring
estimatedLossPctnumber (float)
firewallEnabledboolean
gatewayIpv4object
gatewayIpv6object
handshakeLatencyMsnumber (int64)
ispIpv4object
ispIpv6object
metalstring
modestringThe mode under which the WARP client is run (example: proxy)
networkRcvdBpsinteger (int64)
networkSentBpsinteger (int64)
networkSsidstring
personEmailstringUser contact email address
platformstringOperating system (example: windows)
ramAvailableKbinteger (int64)
ramUsedPctnumber (float)
ramUsedPctByApparray
registrationIdstringDevice registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user's registration on the device.
statusstringNetwork status (example: connected)
switchLockedboolean
timestampstringTimestamp in ISO format (example: 2023-10-11T00:00:00Z)
versionstringWARP client version (example: 1.0.0)
wifiStrengthDbminteger (int64)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_idto, from, page, per_page, sort_by, colo, device_id, mode, status, platform, version, sourceList details for devices using WARP

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
colostringCloudflare colo
device_idstringDevice-specific ID, given as UUID v4
fromstringTime range beginning in ISO format
modestringThe mode under which the WARP client is run
pagenumberPage number
per_pagenumberNumber of results per page
platformstringOperating system
sort_bystringDimension to sort results by
sourcestringSource: * 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
statusstringNetwork status
tostringTime range end in ISO format
versionstringWARP client version

SELECT examples

List details for devices using WARP

SELECT
alwaysOn,
batteryCharging,
batteryCycles,
batteryPct,
colo,
connectionType,
cpuPct,
cpuPctByApp,
deviceId,
deviceIpv4,
deviceIpv6,
deviceName,
diskReadBps,
diskUsagePct,
diskWriteBps,
dohSubdomain,
estimatedLossPct,
firewallEnabled,
gatewayIpv4,
gatewayIpv6,
handshakeLatencyMs,
ispIpv4,
ispIpv6,
metal,
mode,
networkRcvdBps,
networkSentBps,
networkSsid,
personEmail,
platform,
ramAvailableKb,
ramUsedPct,
ramUsedPctByApp,
registrationId,
status,
switchLocked,
timestamp,
version,
wifiStrengthDbm
FROM cloudflare.zero_trust.fleet_status_devices
WHERE account_id = '{{ account_id }}' -- required
AND to = '{{ to }}'
AND from = '{{ from }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND sort_by = '{{ sort_by }}'
AND colo = '{{ colo }}'
AND device_id = '{{ device_id }}'
AND mode = '{{ mode }}'
AND status = '{{ status }}'
AND platform = '{{ platform }}'
AND version = '{{ version }}'
AND source = '{{ source }}'
;