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/8A9D-9670-D2A8-4267-94C1/sites/6bf8e1ba-fa3c-40bc-8d97-ab9e31927724/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": "980ff1a3-0cbc-494e-a55c-d78caa23e05b,79d3146a-4397-405d-aea2-cf7c81db4e8e", "Command": "changekeycode", "Parameters": "1FE5-40CD-A9E2-42F4-8A79" }
<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>980ff1a3-0cbc-494e-a55c-d78caa23e05b,79d3146a-4397-405d-aea2-cf7c81db4e8e</EndpointsList> <Parameters>1FE5-40CD-A9E2-42F4-8A79</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).