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

Commands

List account commands
zero_trust.dex.commands.list(CommandListParams**kwargs) -> SyncV4PagePagination[Optional[CommandListResponse]]
GET/accounts/{account_id}/dex/commands
Create account commands
zero_trust.dex.commands.create(CommandCreateParams**kwargs) -> CommandCreateResponse
POST/accounts/{account_id}/dex/commands
ModelsExpand Collapse
class CommandListResponse: …
commands: Optional[List[Command]]
id: Optional[str]
completed_date: Optional[datetime]
formatdate-time
created_date: Optional[datetime]
formatdate-time
device_id: Optional[str]
filename: Optional[str]
registration_id: Optional[str]

Unique identifier for the device registration

status: Optional[str]
type: Optional[str]
user_email: Optional[str]
class CommandCreateResponse: …
commands: Optional[List[Command]]

List of created commands

id: Optional[str]

Unique identifier for the command

args: Optional[Dict[str, str]]

Command arguments

device_id: Optional[str]

Identifier for the device associated with the command

registration_id: Optional[str]

Unique identifier for the device registration

status: Optional[Literal["PENDING_EXEC", "PENDING_UPLOAD", "SUCCESS", "FAILED"]]

Current status of the command

One of the following:
"PENDING_EXEC"
"PENDING_UPLOAD"
"SUCCESS"
"FAILED"
type: Optional[str]

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

CommandsDevices

List devices eligible for remote captures
zero_trust.dex.commands.devices.list(DeviceListParams**kwargs) -> SyncV4PagePagination[Optional[DeviceListResponse]]
GET/accounts/{account_id}/dex/commands/devices
ModelsExpand Collapse
class DeviceListResponse: …
devices: Optional[List[Device]]

List of eligible devices

device_id: Optional[str]

Device identifier (UUID v4)

device_name: Optional[str]

Device identifier (human readable)

eligible: Optional[bool]

Whether the device is eligible for remote captures

ineligible_reason: Optional[str]

If the device is not eligible, the reason why.

person_email: Optional[str]

User contact email address

platform: Optional[str]

Operating system.

registration_id: Optional[str]

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

status: Optional[str]

Network status.

timestamp: Optional[str]
version: Optional[str]

WARP client version.

CommandsDownloads

Download command output file
zero_trust.dex.commands.downloads.get(strfilename, DownloadGetParams**kwargs) -> BinaryResponseContent
GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

CommandsQuota

Returns account commands usage, quota, and reset time
zero_trust.dex.commands.quota.get(QuotaGetParams**kwargs) -> QuotaGetResponse
GET/accounts/{account_id}/dex/commands/quota
ModelsExpand Collapse
class QuotaGetResponse: …
quota: float

The total number of commands that can be initiated for an account.

quota_usage: float

The number of commands that have been initiated for an account.

reset_time: datetime

The time when the quota resets.

formatdate-time