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/8A70-CF8B-53DF-4509-8543/sites/9171f330-76d9-4da2-b345-def275c282a5/endpoints/commands

Body Parameters

Additional information for issuing an agent command.

SetCommandRequestModel

Name	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.

Name

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": "99422df0-5f34-4945-b38a-d7cbd1d239b2,bb7bbe95-0e2c-4ef9-b611-be80cd081a3d",
  "Command": "changekeycode",
  "Parameters": "F7A4-AE07-A336-4D5D-89CD"
}

<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>99422df0-5f34-4945-b38a-d7cbd1d239b2,bb7bbe95-0e2c-4ef9-b611-be80cd081a3d</EndpointsList>
  <Parameters>F7A4-AE07-A336-4D5D-89CD</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).