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/4490-1194-653D-4483-A331/sites/340884b4-4d98-40f3-b1db-3cf2369228c2/groups/5f15f655-71cb-450f-82da-309ad2d798f5/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". |
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": "EB49-A2C6-E249-4AAE-8340" }
<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>EB49-A2C6-E249-4AAE-8340</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).