POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}/endpoints/commands

Issues an agent command to a group of endpoints.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

groupId

The group identifier.

string

Required

Body Parameters

Additional information for issuing an agent command.

SetCommandGroupRequestModel
NameDescriptionTypeAdditional Information
Command

The type of the command. Valid values are "scan", "cleanup", "uninstall", "changekeycode", "restart".

string

Required

Parameters

The parameters required for the command (e.g. required for the "changekeycode" command to specify the keycode).

string

None.

Sample Request

{
  "Command": "changekeycode",
  "Parameters": "0C2C-574C-17E4-4E5B-AE30"
}                    
<SetCommandGroupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Command>changekeycode</Command>
  <Parameters>0C2C-574C-17E4-4E5B-AE30</Parameters>
</SetCommandGroupRequestModel>                    

Response Information

Resource Description

None. If successful, this API action does not return any data and the response status code will be 204 (No Content).