Commands

APIs to run device commands. This version of commands is being deprecated and documentation will be archived soon. Please use Commands V2.

Run commands on deviceDeprecated

Fire commands on device like reboot, ping etc. Deprecated in favour of commands V2.

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

ID of the enterprise

device_id
required
string <uuid>

ID of the device

Request Body schema: */*

Command request body

object (Command args)
command
required
string (DeviceCommandEnum)

Command Options

* REBOOT: Reboot device
* LOCK:  Lock device screen
* INSTALL:  Install an app on device
* UNINSTALL: Uninstall an app from device
* WIPE: Wipe device
* UPDATE_HEARTBEAT: Ping Device
* SET_WIFI_STATE: wifi on/off
* SET_BLUETOOTH_STATE: Bluetooth on/off
* SET_ROTATION_STATE: Auto rotate setting
* SET_GPS_STATE: GPS options
* SET_BRIGHTNESS_SCALE: Brightness control
* SET_STREAM_VOLUME: Volume control
* SET_SCREEN_OFF_TIMEOUT: Screen timeout setting
* ADD_TO_WHITELIST: Whitelist an installed sytem app
* CLEAR_APP_DATA: Clear app data
* CAPTURE_SCREENSHOT: Allows you to take a screenshot of the device's current screen. The "tag" is an optional param that can be set to corresponding screenshot. 
Enum: "REBOOT" "LOCK" "INSTALL" "UPDATE_HEARTBEAT" "WIPE" "SET_WIFI_STATE" "SET_BLUETOOTH_STATE" "SET_ROTATION_STATE" "SET_GPS_STATE" "SET_BRIGHTNESS_SCALE" "SET_STREAM_VOLUME" "SET_SCREEN_OFF_TIMEOUT" "UNINSTALL" "ADD_TO_WHITELIST" "CLEAR_APP_DATA" "CAPTURE_SCREENSHOT"
Responses
200

successful operation

post/enterprise/{enterprise_id}/device/{device_id}/command/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "current_base_uri": "string",
  • "command_args": {
    },
  • "action": "acknowledge",
  • "schedule": "string",
  • "group_schedule_id": "2f90db6c-20db-4482-99f1-a8c01b85bec7",
  • "command": "REBOOT",
  • "state": "Command Initiated",
  • "details": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "device": "string",
  • "group_command": "string",
  • "issued_by": "string"
}

Get command statusDeprecated

Return DeviceCommand instance. Deprecated in favour of commands V2.

Request
Security:
path Parameters
command_id
required
string <uuid>

A UUID string identifying this device command.

device_id
required
string <uuid>

A UUID string identifying this device.

enterprise_id
required
string <uuid>

A UUID string identifying enterprise.

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/{device_id}/command/{command_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "current_base_uri": "string",
  • "command_args": {
    },
  • "action": "acknowledge",
  • "schedule": "string",
  • "group_schedule_id": "2f90db6c-20db-4482-99f1-a8c01b85bec7",
  • "command": "REBOOT",
  • "state": "Command Initiated",
  • "details": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "device": "string",
  • "group_command": "string",
  • "issued_by": "string"
}