Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DEX

Commands

List account commands
client.zeroTrust.dex.commands.list(CommandListParams { account_id, page, per_page, 6 more } params, RequestOptionsoptions?): V4PagePagination<CommandListResponse { commands } >
GET/accounts/{account_id}/dex/commands
Create account commands
client.zeroTrust.dex.commands.create(CommandCreateParams { account_id, commands } params, RequestOptionsoptions?): CommandCreateResponse { commands }
POST/accounts/{account_id}/dex/commands
ModelsExpand Collapse
CommandListResponse { commands }
commands?: Array<Command>
id?: string
completed_date?: string | null
formatdate-time
created_date?: string
formatdate-time
device_id?: string
filename?: string | null
registration_id?: string

Unique identifier for the device registration

status?: string
type?: string
user_email?: string
CommandCreateResponse { commands }
commands?: Array<Command>

List of created commands

id?: string

Unique identifier for the command

args?: Record<string, string>

Command arguments

device_id?: string

Identifier for the device associated with the command

registration_id?: string

Unique identifier for the device registration

status?: "PENDING_EXEC" | "PENDING_UPLOAD" | "SUCCESS" | "FAILED"

Current status of the command

One of the following:
"PENDING_EXEC"
"PENDING_UPLOAD"
"SUCCESS"
"FAILED"
type?: string

Type of the command (e.g., “pcap” or “warp-diag”)

CommandsDevices

List devices eligible for remote captures
client.zeroTrust.dex.commands.devices.list(DeviceListParams { account_id, page, per_page, search } params, RequestOptionsoptions?): V4PagePagination<DeviceListResponse { devices } >
GET/accounts/{account_id}/dex/commands/devices
ModelsExpand Collapse
DeviceListResponse { devices }
devices?: Array<Device>

List of eligible devices

deviceId?: string

Device identifier (UUID v4)

deviceName?: string

Device identifier (human readable)

eligible?: boolean

Whether the device is eligible for remote captures

ineligibleReason?: string

If the device is not eligible, the reason why.

personEmail?: string

User contact email address

platform?: string

Operating system

registrationId?: string

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

status?: string

Network status

timestamp?: string

Timestamp in ISO format

version?: string

WARP client version

CommandsDownloads

Download command output file
client.zeroTrust.dex.commands.downloads.get(stringcommandId, stringfilename, DownloadGetParams { account_id } params, RequestOptionsoptions?): Response
GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

CommandsQuota

Returns account commands usage, quota, and reset time
client.zeroTrust.dex.commands.quota.get(QuotaGetParams { account_id } params, RequestOptionsoptions?): QuotaGetResponse { quota, quota_usage, reset_time }
GET/accounts/{account_id}/dex/commands/quota
ModelsExpand Collapse
QuotaGetResponse { quota, quota_usage, reset_time }
quota: number

The remaining number of commands that can be initiated for an account

quota_usage: number

The number of commands that have been initiated for an account

reset_time: string

The time when the quota resets

formatdate-time