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/0773-2B1D-5B77-4ABC-8FA3/sites/608654f3-aa0b-4348-bd81-3928352a3505/groups/7a74be7f-8104-400c-b0b0-de29bec9dafc/endpoints/commands
|
Body Parameters
Additional information for issuing an agent command.
SetCommandGroupRequestModel| Name | 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": "744F-3FCD-74CA-421F-9F3F"
}
<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>744F-3FCD-74CA-421F-9F3F</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).