GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/threathistory
?startDate={startDate}
&endDate={endDate}
&returnedInfo={returnedInfo}
&pageSize={pageSize}
&pageNr={pageNr}
Gets threat history information for endpoints on a GSM site.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site 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/threathistory
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/threathistory?returnedInfo=ExtendedInfo
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/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.
GetThreatHistoryResponseModelName | 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-01-24T06:33:00.290613Z", "EndDate": "2024-04-24T06:33:00.290613Z", "ThreatRecords": [ { "EndpointId": "9480c117-1346-4b71-8ece-142f5afd5aaa", "MachineId": "7844419880DF446A88D7083741C34230:::702FF33CC5F64F39A8DD4CD1552EE302:::702FF33CC5F64F39A8DD4CD1552EE302", "HostName": "MyComputer1", "FileName": "eicar.com", "PathName": "?:\\users\\user1\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-04-11T06:33:00.290613Z", "LastSeen": "2024-04-22T06:33:00.290613Z", "ExtendedInfo": { "DwellTime": 456, "FileMD5": "E2AD46E8CF5C4849B4C6171C17469D88", "FileSize": 68, "UserName": "User1", "IPAddress": "95.15.167.210", "Determination": "B", "FileVendor": "", "FileProduct": "", "FileVersion": "" } }, { "EndpointId": "217673af-667b-48d7-84cb-d5250563506d", "MachineId": "2716ACE812D340C08AE755F62EF9438C:::692671014BAF49EAA1DEB31143AFCDD4:::692671014BAF49EAA1DEB31143AFCDD4", "HostName": "MyComputer2", "FileName": "eicar.com", "PathName": "?:\\users\\user2\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-04-11T06:33:00.290613Z", "LastSeen": "2024-04-22T06:33:00.290613Z", "ExtendedInfo": { "DwellTime": 366, "FileMD5": "DD4013DAD8364804BDB2768530A0D5A2", "FileSize": 68, "UserName": "User2", "IPAddress": "95.111.62.195", "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-04-24T06:33:00.290613Z</EndDate> <MoreAvailable>false</MoreAvailable> <PageNr>1</PageNr> <PageSize>50</PageSize> <StartDate>2024-01-24T06:33:00.290613Z</StartDate> <ThreatRecords> <GetThreatHistoryResponseModel_Record> <EndpointId>9480c117-1346-4b71-8ece-142f5afd5aaa</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>456</DwellTime> <FileMD5>E2AD46E8CF5C4849B4C6171C17469D88</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.15.167.210</IPAddress> <UserName>User1</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-04-11T06:33:00.290613Z</FirstSeen> <HostName>MyComputer1</HostName> <LastSeen>2024-04-22T06:33:00.290613Z</LastSeen> <MachineId>7844419880DF446A88D7083741C34230:::702FF33CC5F64F39A8DD4CD1552EE302:::702FF33CC5F64F39A8DD4CD1552EE302</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user1\desktop</PathName> </GetThreatHistoryResponseModel_Record> <GetThreatHistoryResponseModel_Record> <EndpointId>217673af-667b-48d7-84cb-d5250563506d</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>366</DwellTime> <FileMD5>DD4013DAD8364804BDB2768530A0D5A2</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.111.62.195</IPAddress> <UserName>User2</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-04-11T06:33:00.290613Z</FirstSeen> <HostName>MyComputer2</HostName> <LastSeen>2024-04-22T06:33:00.290613Z</LastSeen> <MachineId>2716ACE812D340C08AE755F62EF9438C:::692671014BAF49EAA1DEB31143AFCDD4:::692671014BAF49EAA1DEB31143AFCDD4</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user2\desktop</PathName> </GetThreatHistoryResponseModel_Record> </ThreatRecords> </GetThreatHistoryResponseModel>