POST /accounts/{account_id}/dex/commands

Initiate commands for up to 10 devices per account.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Unique Cloudflare account ID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
commands[] Array Yes

List of device-level commands to execute

commands[].user_email String Yes

Email tied to the device

commands[].device_id String Yes

Unique identifier for the physical device

commands[].type String Yes

Type of command to execute on the device

Valid values:

  • "pcap"
  • "warp-diag"
  • "speed-test"
commands[].registration_id String No

Unique identifier for the device registration. Required for multi-user devices to target the correct user session.

commands[].args Object No

Command arguments. Allowed fields depend on type.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.