GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}/threathistory
?startDate={startDate}
&endDate={endDate}
&returnedInfo={returnedInfo}
&pageSize={pageSize}
&pageNr={pageNr}
Gets threat history information for endpoints on a group.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
| groupId |
The group identifier. |
string |
Required |
| startDate |
If specified, returns all threat history records after (or at) the given date. If omitted, defaults to 'endDate' minus 24 hours. |
date |
None. |
| endDate |
If specified, returns all threat history records before (or at) the given date. If omitted, defaults to the current date and time. |
date |
None. |
| returnedInfo |
A comma separated list of classes of information to be provided in response data. Currently only the "ExtendedInfo" class is supported as a value. If omitted, general threat record information is returned only. |
string |
None. |
| pageSize |
Specifies the number of records to return. |
integer |
Default value is 50 |
| pageNr |
Specifies the page number. Can be used to retrieve the next batch of records. |
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/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/threathistory
|
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/threathistory?returnedInfo=ExtendedInfo
|
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/threathistory?startDate=2018-09-01&endDate=2018-09-30&pageSize=100&pageNr=3
|
Body Parameters
None.
Response Information
Resource Description
Information about matching threat history records.
GetThreatHistoryResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| MoreAvailable |
Value indicating whether more records are available in the queried time window. Increment the page number in the query to obtain additional threat history records. |
boolean |
None. |
| PageNr |
The number of the page that was requested. |
integer |
None. |
| PageSize |
The size of the page that was requested. |
integer |
None. |
| StartDate |
Start date for returned records. Threat history entries after (or at) this date are contained in the response. |
date |
None. |
| EndDate |
End date for returned records. Threat history entries before (or at) this date are contained in the response. |
date |
None. |
| ThreatRecords |
List of threat history records. |
Collection of GetThreatHistoryResponseModel_Record |
None. |
Sample Response
{
"MoreAvailable": false,
"PageNr": 1,
"PageSize": 50,
"StartDate": "2024-06-09T09:17:18.0582287Z",
"EndDate": "2024-09-09T09:17:18.0582287Z",
"ThreatRecords": [
{
"EndpointId": "a1e92862-6dfa-408d-8779-1c5a9c1f8aab",
"MachineId": "B64B4AB13B6D42F49373B98B91AD2041:::BD67EDA773834237A05A61ADF0EBACC8:::BD67EDA773834237A05A61ADF0EBACC8",
"HostName": "MyComputer1",
"FileName": "eicar.com",
"PathName": "?:\\users\\user1\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2024-08-27T09:17:18.0582287Z",
"LastSeen": "2024-09-07T09:17:18.0582287Z",
"ExtendedInfo": {
"DwellTime": 342,
"FileMD5": "37D3AA21809747C1B29C745E5323B95A",
"FileSize": 68,
"UserName": "User1",
"IPAddress": "95.8.121.99",
"Determination": "B",
"FileVendor": "",
"FileProduct": "",
"FileVersion": ""
}
},
{
"EndpointId": "901bf709-1c38-41cb-ac61-a611b86abeba",
"MachineId": "CAFC29BCCFC14E6894FDC1B6DBDAAB1E:::D29F4439563D4CE8BC4A61C2167054EE:::D29F4439563D4CE8BC4A61C2167054EE",
"HostName": "MyComputer2",
"FileName": "eicar.com",
"PathName": "?:\\users\\user2\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2024-08-27T09:17:18.0582287Z",
"LastSeen": "2024-09-07T09:17:18.0582287Z",
"ExtendedInfo": {
"DwellTime": 216,
"FileMD5": "49D9B642CD1C463880328E9E1F07EFBC",
"FileSize": 68,
"UserName": "User2",
"IPAddress": "95.157.136.234",
"Determination": "B",
"FileVendor": "",
"FileProduct": "",
"FileVersion": ""
}
}
]
}
<GetThreatHistoryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
<EndDate>2024-09-09T09:17:18.0582287Z</EndDate>
<MoreAvailable>false</MoreAvailable>
<PageNr>1</PageNr>
<PageSize>50</PageSize>
<StartDate>2024-06-09T09:17:18.0582287Z</StartDate>
<ThreatRecords>
<GetThreatHistoryResponseModel_Record>
<EndpointId>a1e92862-6dfa-408d-8779-1c5a9c1f8aab</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>342</DwellTime>
<FileMD5>37D3AA21809747C1B29C745E5323B95A</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.8.121.99</IPAddress>
<UserName>User1</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2024-08-27T09:17:18.0582287Z</FirstSeen>
<HostName>MyComputer1</HostName>
<LastSeen>2024-09-07T09:17:18.0582287Z</LastSeen>
<MachineId>B64B4AB13B6D42F49373B98B91AD2041:::BD67EDA773834237A05A61ADF0EBACC8:::BD67EDA773834237A05A61ADF0EBACC8</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user1\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
<GetThreatHistoryResponseModel_Record>
<EndpointId>901bf709-1c38-41cb-ac61-a611b86abeba</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>216</DwellTime>
<FileMD5>49D9B642CD1C463880328E9E1F07EFBC</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.157.136.234</IPAddress>
<UserName>User2</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2024-08-27T09:17:18.0582287Z</FirstSeen>
<HostName>MyComputer2</HostName>
<LastSeen>2024-09-07T09:17:18.0582287Z</LastSeen>
<MachineId>CAFC29BCCFC14E6894FDC1B6DBDAAB1E:::D29F4439563D4CE8BC4A61C2167054EE:::D29F4439563D4CE8BC4A61C2167054EE</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user2\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
</ThreatRecords>
</GetThreatHistoryResponseModel>