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
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
groupId |
The group identifier. |
string |
Required |
URI Sample(s)
POST
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/9B37-8DB6-C325-4428-9A16/sites/6f7b2b5c-c41e-41a1-a7a0-f7941f9e2bbe/groups/46f30e49-5669-42e4-a228-20d1ca5c1e89/endpoints/commands
|
Body Parameters
Additional information for issuing an agent command.
SetCommandGroupRequestModelName | Description | Type | Additional Information |
---|---|---|---|
Command |
The type of the command. Valid values are "scan", "cleanup", "uninstall", "changekeycode", "restart", "sysisolate". |
string |
Required |
Parameters |
The parameters required for the command. changekeycode and sysisolate commands require a Parameters value to be specified - for changekeycode the value needs to be the keycode to change to, for sysisolate the value needs to be either "on" (for isolating) or "off" (for unisolating). |
string |
None. |
Sample Request
{ "Command": "changekeycode", "Parameters": "194C-2448-8887-4D1D-AB33" }
<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>194C-2448-8887-4D1D-AB33</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).