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 |
URI Sample(s)
POST
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/1589-1325-1574-43A0-BC99/sites/ce8b31a6-e33f-4188-b4a8-8ad596e13945/endpoints/commands
|
Body Parameters
Additional information for issuing an agent command.
SetCommandRequestModelName | 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", "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
{ "EndpointsList": "9ad13db5-b8d8-432a-a29e-c2da9cb743af,77558dc4-e30f-485e-9332-d50e6d4281c4", "Command": "changekeycode", "Parameters": "B3D8-7121-1611-4DA7-8749" }
<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>9ad13db5-b8d8-432a-a29e-c2da9cb743af,77558dc4-e30f-485e-9332-d50e6d4281c4</EndpointsList> <Parameters>B3D8-7121-1611-4DA7-8749</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).