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/37FF-4436-94B9-4C4C-BA76/sites/8700684f-2dd1-452f-bab8-abdd39471a45/groups/2a933bb2-10dd-43f4-b85d-89313d73f929/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", "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": "90E3-7E0D-66AE-4BF4-B98C"
}
<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>90E3-7E0D-66AE-4BF4-B98C</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).