Commands the device with the given uuid to perform the action specified by actionName. If the action has arguments, they must be provided in the body of the request as key value pairs, where the key is the name of the argument, and the value its value. The arguments provided must be the same as those in the device descriptor.

Request specification

  • Method: POST
  • URL: /devices/{uuid}/actions/{actionName}

Example Request

  • Request URL:
  • Request headers: X-Api-Key: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
  • Request method: POST
  • Request body:
    • Actions with no arguments: [ ]
    • Actions with arguments:
       [ { "name": "arg1", "value": "123"}, {"name": "arg2", "value": "monday"} ]

Example Response

  • HTTP status: 200 OK
  • Response body:

Error summary

  • 200: success.
  • 400: bad request. Usually caused by a wrong action name or a wrong number or type of arguments.
  • 401: Api key not provided or invalid.
  • 404: given uuid does not match any installed device.
Back to top