Execute Gateway Command on a device

post https://api.edgeiq.io/api/v1/platform/devices/{id}/gateway_command

Path Params

string

required

Body Params

command_type

string

The type of command.

payload

object

The payload that is sent to the device. Not all commands require a payload.

schedule

object

GatewayCommandSchedules define when a GatewayCommand can be executed. Note that this currently applies only to software update type gateway commands.

timeout

integer

The number of seconds before the command will be aborted.

device_id

string

The _id of the device that will receive the command.

settings_id

string

The _id of the setting that will receive the command.

command_id

string

The _id of the command that will receive the gateway command.

software_update_id

string

The _id of the software update to use for the command. This value is only required when issuing a software_update command.

attached_device_ids

array of strings

Allows for targeting specific attached device _id's via the gateway device.

attached_device_ids

retry_options

object

optional. Details about how to retry this gateway command, where supported

type

string

The type of LWM2M command (use only with command_type lwm2m_request or lwm2m_file).
For lwm2m_request:

'read', 'observe', 'observe_stop', 'exec' you must specify the LWM2M path in the field 'endpoint'
'write' the path in 'endpoint' and the value in the field 'data'

For lwm2m_file:

'fileupload' to push a file to the device, you must specify the file id in the field 'file_id' and the file path on the device in the field 'filepath'
'filedownload' to get a file from the device, you must specify the file path on the device in the field 'filepath'.

endpoint

string

the LWM2M path targeted by a gateway_command of type lwm2m_request

data

the value for a LWM2M command of type 'write'

filepath

string

for command of type 'lwm2m_file' the path of the file to retrieve or replace on a device

file_id

string

for command of type 'lwm2m_file' and type 'fileupload', the identifier of the file to be pushed to the device

Response

200

Language

Credentials

Header


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://api.edgeiq.io/api/v1/platform/devices/id/gateway_command \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "retry_options": {
8
    "timeout": 180,
9
    "max_retries": 5,
10
    "retry_strategy": {
11
      "type": "none",
12
      "fixed_interval": 180,
13
      "exponential_base_interval": 180,
14
      "exponential_multiplier": 2,
15
      "exponential_max_interval": 3600
16
    }
17
  }
18
}
19
'

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