POST /accounts/{account_id}/dex/commands
Initiate commands for up to 10 devices per account
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
unique identifier linked to an account in the API request path |
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[].command_args |
Object | No | |
commands[].command_args.test-all-routes |
Boolean | No |
Test an IP address from all included or excluded ranges. Tests an IP address from all included or excluded ranges. Essentially the same as running 'route get '' and collecting the results. This option may increase the time taken to collect the warp-diag Default value: true |
commands[].command_args.interfaces[] |
Array | No |
List of interfaces to capture packets on |
commands[].command_args.packet-size-bytes |
Number | No |
Maximum number of bytes to save for each packet Default value: 160 |
commands[].command_args.max-file-size-mb |
Number | No |
Maximum file size (in MB) for the capture file. Specifies the maximum file size of the warp-diag zip artifact that can be uploaded. If the zip artifact exceeds the specified max file size, it will NOT be uploaded Default value: 5 |
commands[].command_args.time-limit-min |
Number | No |
Limit on capture duration (in minutes) Default value: 5 |
commands[].user_email |
String | Yes |
Email tied to the device |
commands[].command_type |
String | Yes |
Type of command to execute on the device Possible values:
|
commands[].device_id |
String | Yes |
Unique identifier for the device |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.