Group Commands

APIs to run group commands. Command will be run on all the active devices in a group

Run commands on group devicesDeprecated

Fire commands on all the group devices. Deprecated in favour of commands V2.

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

ID of the enterprise

group_id
required
string <uuid>

ID of the group

Request Body schema: */*

Group command request

object (Command args)
command
required
string (GroupCommandEnum)

Group Command Options

* REBOOT: Reboot device
* LOCK:  Lock device screen
* INSTALL:  Install an app on device
* UPDATE_HEARTBEAT: Ping Device
Enum: "REBOOT" "LOCK" "INSTALL" "UPDATE_HEARTBEAT"
Responses
201

successful operation

post/enterprise/{enterprise_id}/devicegroup/{group_id}/command/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "schedule": "string",
  • "command": "REBOOT",
  • "command_args": {
    },
  • "state": "Command Initiated",
  • "details": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "enterprise": "string",
  • "group": "string",
  • "issued_by": "http://example.com"
}

Get group command statusDeprecated

Returns GroupCommand instance. Deprecated in favour of commands V2.

Request
Security:
path Parameters
command_id
required
string <uuid>

A UUID string identifying this device command.

group_id
required
string <uuid>

A UUID string identifying this group.

enterprise_id
required
string <uuid>

A UUID string identifying enterprise.

Responses
200

successful operation

get/enterprise/{enterprise_id}/devicegroup/{group_id}/command/{command_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "schedule": "string",
  • "command": "REBOOT",
  • "command_args": {
    },
  • "state": "Command Initiated",
  • "details": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "enterprise": "string",
  • "group": "string",
  • "issued_by": "http://example.com"
}