GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/commands
?endpointId={endpointId}
&command={command}
&commandState={commandState}
&startDate={startDate}
&endDate={endDate}
&order={order}
&orderDirection={orderDirection}
&pageSize={pageSize}
&pageNr={pageNr}
Gets a list of executed commands on a given GSM site.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
endpointId |
The endpoint identifier to get the executed command for. |
string |
None. |
command |
Used to filter by command type. Valid values are "scan", "cleanup", "uninstall", "changekeycode", "restart". |
string |
None. |
commandState |
Used to filter by the state. Valid values are:
|
string |
None. |
startDate |
If specified, returns all issued commands after (or at) the given date. |
date |
None. |
endDate |
If specified, returns all issued commands before (or at) the given date. |
date |
None. |
order |
Used to determine the order field. Valid values are "daterequested", "hostname", "commandstate", "command". Default value is "daterequested". |
string |
None. |
orderDirection |
Used to sort the data. "A" for ascending, "D" for descending. If orderDirection is omitted or invalid, the data will be sorted in descending order. |
string |
None. |
pageSize |
Specifies the number of records being returned. |
integer |
Default value is 50 |
pageNr |
Specifies the page number. Can be used to retrieve the next batch of records. Default value is 1. |
integer |
Default value is 1 |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/commands
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/commands?command=scan
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/commands?endpointId=ea1563b2-4536-4017-b329-38e969fc5a06&commandState=3
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/commands?order=command&orderDirection=A
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/commands?startDate=2018-09-01&endDate=2018-09-30&pageSize=100&pageNr=3
|
Body Parameters
None.
Response Information
Resource Description
Information about the executed commands.
GetCommandsResponseModelName | Description | Type | Additional Information |
---|---|---|---|
TotalAvailable |
The total number of commands in the past 6 months. Use this value to determine if you need to retrieve additional pages of data. |
integer |
None. |
PageNr |
The number of the page that was requested. |
integer |
None. |
PageSize |
The size of the page that was requested. |
integer |
None. |
Commands |
List of command records. |
Collection of GetCommandsResponseModel_Command |
None. |
Sample Response
{ "TotalAvailable": 2, "PageNr": 1, "PageSize": 50, "Commands": [ { "DateRequested": "2023-02-08T23:35:39.8212223Z", "EndpointId": "1e055263-768e-4bfa-805d-3c6b347c73e4", "HostName": "MyComputer1", "StartDate": "2023-02-09T02:35:39.8212223Z", "EndDate": "2023-02-09T12:35:39.8212223Z", "Command": "scan", "Parameters": null, "CommandState": 1 }, { "DateRequested": "2023-02-08T22:35:39.8212223Z", "EndpointId": "99bcf381-da9d-4bc9-bb78-154d95cfd170", "HostName": "MyComputer2", "StartDate": "2023-02-09T03:35:39.8212223Z", "EndDate": "2023-02-09T13:35:39.8212223Z", "Command": "scan", "Parameters": null, "CommandState": 1 } ] }
<GetCommandsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <Commands> <GetCommandsResponseModel_Command> <Command>scan</Command> <CommandState>1</CommandState> <DateRequested>2023-02-08T23:35:39.8212223Z</DateRequested> <EndDate>2023-02-09T12:35:39.8212223Z</EndDate> <EndpointId>1e055263-768e-4bfa-805d-3c6b347c73e4</EndpointId> <HostName>MyComputer1</HostName> <Parameters i:nil="true" /> <StartDate>2023-02-09T02:35:39.8212223Z</StartDate> </GetCommandsResponseModel_Command> <GetCommandsResponseModel_Command> <Command>scan</Command> <CommandState>1</CommandState> <DateRequested>2023-02-08T22:35:39.8212223Z</DateRequested> <EndDate>2023-02-09T13:35:39.8212223Z</EndDate> <EndpointId>99bcf381-da9d-4bc9-bb78-154d95cfd170</EndpointId> <HostName>MyComputer2</HostName> <Parameters i:nil="true" /> <StartDate>2023-02-09T03:35:39.8212223Z</StartDate> </GetCommandsResponseModel_Command> </Commands> <PageNr>1</PageNr> <PageSize>50</PageSize> <TotalAvailable>2</TotalAvailable> </GetCommandsResponseModel>