POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/endpoints/commands
Issues an agent command to a list of endpoints, or to all endpoints on a site.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
Body Parameters
Additional information for issuing an agent command.
SetCommandRequestModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| EndpointsList |
Comma delimited string of endpoint ids. If not specified, the command gets applied to all endpoints on the site. |
string |
None. |
| 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
{
"EndpointsList": "76032611-cbc7-4288-8fa6-630b605cc3c2,a0aede31-4e4f-4672-8269-f847577bbde6",
"Command": "changekeycode",
"Parameters": "6C0A-4425-17BF-4EC5-83D1"
}
<SetCommandRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <Command>changekeycode</Command> <EndpointsList>76032611-cbc7-4288-8fa6-630b605cc3c2,a0aede31-4e4f-4672-8269-f847577bbde6</EndpointsList> <Parameters>6C0A-4425-17BF-4EC5-83D1</Parameters> </SetCommandRequestModel>
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).