Execute Command on a device

post

https://api.edgeiq.io/api/v1/platform/devices/{id}/commands/{command_id}/execute

Path Params

string

required

command_id

string

required

Body Params

sender_type

string

enum

required

The type of sender used to send the command.

Allowed:

sender

object

An object to specify additional parameters for a command sender type.

name

string

required

The name of the command.

device_id

string

The id of the device to which this command will be sent. This may be omitted until the command is executed.

save_command_output

boolean

If true, the command output will be saved to the device's command history.

translator_id

string

The id of the translator used to translate the command payload into the data format expected by the recipient device. This can be omitted if a translator is not needed to process and send the command.

long_description

string

A long description of the command. This field is intended to be populated with instructions on how to send the command. These instructions can then be displayed to users of an application.

options

object

A JSON object containing metadata needed to process and send the command. This field is not used by commands sent directly by Edge (but may optionally be used by REST Command forwarders and plugins).

payload

string

A JSON object containing all of the data that will comprise the actual message sent to the recipient device. This payload is the input to the translator.

Response

200

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!