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

NameDescriptionTypeAdditional 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/98A5-9CB9-F340-4FD4-B519/sites/66873529-c30f-4996-8901-312c2904d91d/endpoints/commands

Body Parameters

Additional information for issuing an agent command.

SetCommandRequestModel
NameDescriptionTypeAdditional 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": "fdf4c4e4-5f80-4eff-8dbb-2982e640f260,f90dda97-8db7-45b2-bfa0-74ce2dbfb77c",
  "Command": "changekeycode",
  "Parameters": "668C-BF62-B1DB-4D09-87B0"
}                    
<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>fdf4c4e4-5f80-4eff-8dbb-2982e640f260,f90dda97-8db7-45b2-bfa0-74ce2dbfb77c</EndpointsList>
  <Parameters>668C-BF62-B1DB-4D09-87B0</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).