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/BF9E-FA4D-BAE1-4B0B-A41C/sites/28c9e0d3-c2bd-4b2b-beb9-923c2fa9c81b/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": "1ee25e3d-b9da-45f6-8662-c57052a7262a,a7fc6b15-e188-42f7-a64d-3996adb99699", "Command": "changekeycode", "Parameters": "DEC5-0422-557D-42D9-B284" }
<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>1ee25e3d-b9da-45f6-8662-c57052a7262a,a7fc6b15-e188-42f7-a64d-3996adb99699</EndpointsList> <Parameters>DEC5-0422-557D-42D9-B284</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).