API Reference

Creates a Command

post
https://api.edgeiq.io/api/v1/platform/commands

Creates a Command used to send outbound command data to one or more devices.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A sender that sends commands by executing a shell command

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.

string
required

The name of the command.

string

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

boolean

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

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.

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).

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.

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago