List fleet status details by dimension

client.zeroTrust.dex.fleetStatus.live(, ?): FleetStatusLiveResponse { deviceStats }

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

List details for live (up to 60 minutes) 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: FleetStatusLiveParams { account_id, since_minutes }

account_id: string

Path param: Unique identifier for account

maxLength32

since_minutes: number

Query param: Number of minutes before current time

maximum60

minimum1

ReturnsExpand Collapse

FleetStatusLiveResponse { deviceStats }

deviceStats?: DeviceStats { byColo, byMode, byPlatform, 3 more }

byColo?: Array<LiveStat { uniqueDevicesTotal, value } > | null

uniqueDevicesTotal?: number

Number of unique devices

value?: string

byMode?: Array<LiveStat { uniqueDevicesTotal, value } > | null

uniqueDevicesTotal?: number

Number of unique devices

value?: string

byPlatform?: Array<LiveStat { uniqueDevicesTotal, value } > | null

uniqueDevicesTotal?: number

Number of unique devices

value?: string

byStatus?: Array<LiveStat { uniqueDevicesTotal, value } > | null

uniqueDevicesTotal?: number

Number of unique devices

value?: string

byVersion?: Array<LiveStat { uniqueDevicesTotal, value } > | null

uniqueDevicesTotal?: number

Number of unique devices

value?: string

uniqueDevicesTotal?: number

Number of unique devices

List fleet status details by dimension

import Cloudflare from 'cloudflare';

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

const response = await client.zeroTrust.dex.fleetStatus.live({
  account_id: '01a7362d577a6c3019a474fd6f485823',
  since_minutes: 10,
});

console.log(response.deviceStats);

{
  "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": {
    "deviceStats": {
      "byColo": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byMode": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byPlatform": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byStatus": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byVersion": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "uniqueDevicesTotal": 0
    }
  }
}

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": {
    "deviceStats": {
      "byColo": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byMode": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byPlatform": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byStatus": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "byVersion": [
        {
          "uniqueDevicesTotal": 0,
          "value": "value"
        }
      ],
      "uniqueDevicesTotal": 0
    }
  }
}