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-06-08T03:04:16.6169594Z", "EndDate": "2024-09-08T03:04:16.6169594Z", "ThreatRecords": [ { "EndpointId": "6f540119-e8f9-42ba-b99d-19a16446c1b7", "MachineId": "72BF3E11868343A193FB51292CB9AA1F:::ED862BD574144B09B548B9DA621F06DB:::ED862BD574144B09B548B9DA621F06DB", "HostName": "MyComputer1", "FileName": "eicar.com", "PathName": "?:\\users\\user1\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-08-26T03:04:16.6169594Z", "LastSeen": "2024-09-06T03:04:16.6169594Z", "ExtendedInfo": { "DwellTime": 480, "FileMD5": "E0A03AC448F246F0926D229642C1F2C5", "FileSize": 68, "UserName": "User1", "IPAddress": "95.116.72.252", "Determination": "B", "FileVendor": "", "FileProduct": "", "FileVersion": "" } }, { "EndpointId": "8d9cc184-0359-4d8d-af6f-1180d0cdd304", "MachineId": "7465EED10520445B96DB0FCDC4785294:::4637443611274D26977BDC6246A269F2:::4637443611274D26977BDC6246A269F2", "HostName": "MyComputer2", "FileName": "eicar.com", "PathName": "?:\\users\\user2\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-08-26T03:04:16.6169594Z", "LastSeen": "2024-09-06T03:04:16.6169594Z", "ExtendedInfo": { "DwellTime": 365, "FileMD5": "870077FDB3AF4B99AF8A62636F8C5C1D", "FileSize": 68, "UserName": "User2", "IPAddress": "95.196.15.170", "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-08T03:04:16.6169594Z</EndDate> <MoreAvailable>false</MoreAvailable> <PageNr>1</PageNr> <PageSize>50</PageSize> <StartDate>2024-06-08T03:04:16.6169594Z</StartDate> <ThreatRecords> <GetThreatHistoryResponseModel_Record> <EndpointId>6f540119-e8f9-42ba-b99d-19a16446c1b7</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>480</DwellTime> <FileMD5>E0A03AC448F246F0926D229642C1F2C5</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.116.72.252</IPAddress> <UserName>User1</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-08-26T03:04:16.6169594Z</FirstSeen> <HostName>MyComputer1</HostName> <LastSeen>2024-09-06T03:04:16.6169594Z</LastSeen> <MachineId>72BF3E11868343A193FB51292CB9AA1F:::ED862BD574144B09B548B9DA621F06DB:::ED862BD574144B09B548B9DA621F06DB</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user1\desktop</PathName> </GetThreatHistoryResponseModel_Record> <GetThreatHistoryResponseModel_Record> <EndpointId>8d9cc184-0359-4d8d-af6f-1180d0cdd304</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>365</DwellTime> <FileMD5>870077FDB3AF4B99AF8A62636F8C5C1D</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.196.15.170</IPAddress> <UserName>User2</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-08-26T03:04:16.6169594Z</FirstSeen> <HostName>MyComputer2</HostName> <LastSeen>2024-09-06T03:04:16.6169594Z</LastSeen> <MachineId>7465EED10520445B96DB0FCDC4785294:::4637443611274D26977BDC6246A269F2:::4637443611274D26977BDC6246A269F2</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user2\desktop</PathName> </GetThreatHistoryResponseModel_Record> </ThreatRecords> </GetThreatHistoryResponseModel>