Skip to content
Start here

Commands

List account commands
GET/accounts/{account_id}/dex/commands
Create account commands
POST/accounts/{account_id}/dex/commands
ModelsExpand Collapse
CommandListResponse { commands }
commands: optional array of { id, completed_date, created_date, 6 more }
id: optional string
completed_date: optional string
formatdate-time
created_date: optional string
formatdate-time
device_id: optional string
filename: optional string
registration_id: optional string

Unique identifier for the device registration

status: optional string
type: optional string
user_email: optional string
CommandCreateResponse { commands }
commands: optional array of { id, args, device_id, 3 more }

List of created commands

id: optional string

Unique identifier for the command

args: optional map[string]

Command arguments

device_id: optional string

Identifier for the device associated with the command

registration_id: optional string

Unique identifier for the device registration

status: optional "PENDING_EXEC" or "PENDING_UPLOAD" or "SUCCESS" or "FAILED"

Current status of the command

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

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

CommandsDevices

List devices eligible for remote captures
GET/accounts/{account_id}/dex/commands/devices
ModelsExpand Collapse
DeviceListResponse { devices }
devices: optional array of { deviceId, deviceName, eligible, 7 more }

List of eligible devices

deviceId: optional string

Device identifier (UUID v4)

deviceName: optional string

Device identifier (human readable)

eligible: optional boolean

Whether the device is eligible for remote captures

ineligibleReason: optional string

If the device is not eligible, the reason why.

personEmail: optional string

User contact email address

platform: optional string

Operating system

registrationId: optional string

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

status: optional string

Network status

timestamp: optional string

Timestamp in ISO format

version: optional string

WARP client version

CommandsDownloads

Download command output file
GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

CommandsQuota

Returns account commands usage, quota, and 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