Skip to content
Start here

Get the live status of a latest device

client.ZeroTrust.Devices.FleetStatus.Get(ctx, deviceID, params) (*DeviceFleetStatusGetResponse, error)
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
ParametersExpand Collapse
deviceID string

Unique identifier for the physical device (UUID).

params DeviceFleetStatusGetParams
AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32
SinceMinutes param.Field[float64]

Query param: Number of minutes before current time.

maximum60
minimum1
Colo param.Field[string]Optional

Query param: List of data centers to filter results.

TimeNow param.Field[string]Optional

Query param: Current time in ISO format.

ReturnsExpand Collapse
type DeviceFleetStatusGetResponse 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 []DeviceFleetStatusGetResponseCPUPctByAppOptional
CPUPct float64Optional

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

formatfloat
maximum100
minimum0
Name stringOptional

Application name.

DeviceIPV4 DeviceFleetStatusGetResponseDeviceIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseDeviceIPV4LocationOptional
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 DeviceFleetStatusGetResponseDeviceIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseDeviceIPV6LocationOptional
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 DeviceFleetStatusGetResponseGatewayIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseGatewayIPV4LocationOptional
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 DeviceFleetStatusGetResponseGatewayIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseGatewayIPV6LocationOptional
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 DeviceFleetStatusGetResponseISPIPV4Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseISPIPV4LocationOptional
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 DeviceFleetStatusGetResponseISPIPV6Optional
Address stringOptional
ASN int64Optional
Aso stringOptional
Location DeviceFleetStatusGetResponseISPIPV6LocationOptional
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 []DeviceFleetStatusGetResponseRamUsedPctByAppOptional
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 DeviceFleetStatusGetResponseRTTOptional

Round-trip time statistics for the WARP tunnel.

MinRTTUs DeviceFleetStatusGetResponseRTTMinRTTUsOptional

Minimum round-trip time in microseconds.

Downstream int64Optional
Upstream int64Optional
RTTUs DeviceFleetStatusGetResponseRTTRTTUsOptional

Round-trip time in microseconds.

Downstream int64Optional
Upstream int64Optional
RTTVarUs DeviceFleetStatusGetResponseRTTRTTVarUsOptional

Round-trip time variance in microseconds.

Downstream int64Optional
Upstream int64Optional
SwitchLocked boolOptional
TunnelStats DeviceFleetStatusGetResponseTunnelStatsOptional

WARP tunnel packet and byte counters.

BytesLost DeviceFleetStatusGetResponseTunnelStatsBytesLostOptional

Number of bytes lost, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesReceived DeviceFleetStatusGetResponseTunnelStatsBytesReceivedOptional

Number of bytes received, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesRetransmitted DeviceFleetStatusGetResponseTunnelStatsBytesRetransmittedOptional

Number of bytes retransmitted, split by direction.

Downstream int64Optional
Upstream int64Optional
BytesSent DeviceFleetStatusGetResponseTunnelStatsBytesSentOptional

Number of bytes sent, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsLost DeviceFleetStatusGetResponseTunnelStatsPacketsLostOptional

Number of packets lost, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsReceived DeviceFleetStatusGetResponseTunnelStatsPacketsReceivedOptional

Number of packets received, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsRetransmitted DeviceFleetStatusGetResponseTunnelStatsPacketsRetransmittedOptional

Number of packets retransmitted, split by direction.

Downstream int64Optional
Upstream int64Optional
PacketsSent DeviceFleetStatusGetResponseTunnelStatsPacketsSentOptional

Number of packets sent, split by direction.

Downstream int64Optional
Upstream int64Optional
StatsWindowMs int64Optional

The measurement window duration in milliseconds.

TunnelType stringOptional
WifiStrengthDbm int64Optional
formatint64

Get the live status of a latest device

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"),
  )
  fleetStatus, err := client.ZeroTrust.Devices.FleetStatus.Get(
    context.TODO(),
    "cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7",
    zero_trust.DeviceFleetStatusGetParams{
      AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
      SinceMinutes: cloudflare.F(10.000000),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", fleetStatus.NetworkSsid)
}
{
  "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
}
Returns Examples
{
  "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
}