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/79A5-FC7E-9649-4A38-9C02/sites/131951e0-0a5d-4497-97a3-e398df4f7444/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": "7584c0ee-bcde-4d5d-83b5-8408583ddb3e,0cd9ad4a-7e38-4cc9-b96c-7171b80d811d", "Command": "changekeycode", "Parameters": "CAAB-7E1D-5325-47A7-A703" }
<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>7584c0ee-bcde-4d5d-83b5-8408583ddb3e,0cd9ad4a-7e38-4cc9-b96c-7171b80d811d</EndpointsList> <Parameters>CAAB-7E1D-5325-47A7-A703</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).