Get the live status of a latest device

GET/accounts/{account_id}/dex/devices/{device_id}/fleet-status/live

Get the live status of a latest device given device_id from the device_state table

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

Path ParametersExpand Collapse

account_id: string

maxLength32

device_id: string

Device-specific ID, given as UUID v4

Query ParametersExpand Collapse

since_minutes: number

Number of minutes before current time

maximum60

minimum1

colo: optional string

List of data centers to filter results

time_now: optional string

Number of minutes before current time

ReturnsExpand Collapse

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)

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

Get the live status of a latest device

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/dex/devices/$DEVICE_ID/fleet-status/live \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "colo": "SJC",
  "deviceId": "deviceId",
  "mode": "proxy",
  "platform": "windows",
  "status": "connected",
  "timestamp": "2023-10-11T00:00:00Z",
  "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"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "deviceIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "deviceName": "deviceName",
  "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"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "gatewayIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "handshakeLatencyMs": 0,
  "ispIpv4": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "ispIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "metal": "metal",
  "networkRcvdBps": 0,
  "networkSentBps": 0,
  "networkSsid": "networkSsid",
  "personEmail": "personEmail",
  "ramAvailableKb": 0,
  "ramUsedPct": 0,
  "ramUsedPctByApp": [
    [
      {
        "name": "name",
        "ram_used_pct": 0
      }
    ]
  ],
  "registrationId": "registrationId",
  "switchLocked": true,
  "wifiStrengthDbm": 0
}

Returns Examples

{
  "colo": "SJC",
  "deviceId": "deviceId",
  "mode": "proxy",
  "platform": "windows",
  "status": "connected",
  "timestamp": "2023-10-11T00:00:00Z",
  "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"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "deviceIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "deviceName": "deviceName",
  "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"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "gatewayIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "handshakeLatencyMs": 0,
  "ispIpv4": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "ispIpv6": {
    "address": "address",
    "asn": 0,
    "aso": "aso",
    "location": {
      "city": "city",
      "country_iso": "country_iso",
      "state_iso": "state_iso",
      "zip": "zip"
    },
    "netmask": "netmask",
    "version": "version"
  },
  "metal": "metal",
  "networkRcvdBps": 0,
  "networkSentBps": 0,
  "networkSsid": "networkSsid",
  "personEmail": "personEmail",
  "ramAvailableKb": 0,
  "ramUsedPct": 0,
  "ramUsedPctByApp": [
    [
      {
        "name": "name",
        "ram_used_pct": 0
      }
    ]
  ],
  "registrationId": "registrationId",
  "switchLocked": true,
  "wifiStrengthDbm": 0
}