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/2273-DAE7-564B-4C25-AED5/sites/f472166d-b817-4b87-a2ea-a8c6f0ec29fa/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". |
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": "89e78127-4c52-499f-9ee4-0fee9e3d8034,4864e86c-3e9a-42ac-8766-c7a2f69284fd", "Command": "changekeycode", "Parameters": "7510-0D26-C9C2-4D17-B5E5" }
<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>89e78127-4c52-499f-9ee4-0fee9e3d8034,4864e86c-3e9a-42ac-8766-c7a2f69284fd</EndpointsList> <Parameters>7510-0D26-C9C2-4D17-B5E5</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).