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-04-26T23:46:57.2909787Z", "EndDate": "2024-07-26T23:46:57.2909787Z", "ThreatRecords": [ { "EndpointId": "df5a55da-98a3-48b0-b4e8-4371297302ab", "MachineId": "84A41337FC81456E810C8F577E412B22:::FD339F84C4A5447CB61D61CFC05A1DA0:::FD339F84C4A5447CB61D61CFC05A1DA0", "HostName": "MyComputer1", "FileName": "eicar.com", "PathName": "?:\\users\\user1\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-07-13T23:46:57.2909787Z", "LastSeen": "2024-07-24T23:46:57.2909787Z", "ExtendedInfo": { "DwellTime": 218, "FileMD5": "D8231119588C4A9DA413D97902D1EDAE", "FileSize": 68, "UserName": "User1", "IPAddress": "95.72.159.21", "Determination": "B", "FileVendor": "", "FileProduct": "", "FileVersion": "" } }, { "EndpointId": "7f545cd4-d894-42bf-bd2e-9e749bd6a17b", "MachineId": "A78A129F46A643D79860239F0B535249:::B29585A08F3C403A8826E9D353F702CB:::B29585A08F3C403A8826E9D353F702CB", "HostName": "MyComputer2", "FileName": "eicar.com", "PathName": "?:\\users\\user2\\desktop", "MalwareGroup": "Anti-Malware Testfile", "FirstSeen": "2024-07-13T23:46:57.2909787Z", "LastSeen": "2024-07-24T23:46:57.2909787Z", "ExtendedInfo": { "DwellTime": 942, "FileMD5": "EF737E43FE82472581E330F093AEE3A0", "FileSize": 68, "UserName": "User2", "IPAddress": "95.75.135.55", "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-07-26T23:46:57.2909787Z</EndDate> <MoreAvailable>false</MoreAvailable> <PageNr>1</PageNr> <PageSize>50</PageSize> <StartDate>2024-04-26T23:46:57.2909787Z</StartDate> <ThreatRecords> <GetThreatHistoryResponseModel_Record> <EndpointId>df5a55da-98a3-48b0-b4e8-4371297302ab</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>218</DwellTime> <FileMD5>D8231119588C4A9DA413D97902D1EDAE</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.72.159.21</IPAddress> <UserName>User1</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-07-13T23:46:57.2909787Z</FirstSeen> <HostName>MyComputer1</HostName> <LastSeen>2024-07-24T23:46:57.2909787Z</LastSeen> <MachineId>84A41337FC81456E810C8F577E412B22:::FD339F84C4A5447CB61D61CFC05A1DA0:::FD339F84C4A5447CB61D61CFC05A1DA0</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user1\desktop</PathName> </GetThreatHistoryResponseModel_Record> <GetThreatHistoryResponseModel_Record> <EndpointId>7f545cd4-d894-42bf-bd2e-9e749bd6a17b</EndpointId> <ExtendedInfo> <Determination>B</Determination> <DwellTime>942</DwellTime> <FileMD5>EF737E43FE82472581E330F093AEE3A0</FileMD5> <FileProduct></FileProduct> <FileSize>68</FileSize> <FileVendor></FileVendor> <FileVersion></FileVersion> <IPAddress>95.75.135.55</IPAddress> <UserName>User2</UserName> </ExtendedInfo> <FileName>eicar.com</FileName> <FirstSeen>2024-07-13T23:46:57.2909787Z</FirstSeen> <HostName>MyComputer2</HostName> <LastSeen>2024-07-24T23:46:57.2909787Z</LastSeen> <MachineId>A78A129F46A643D79860239F0B535249:::B29585A08F3C403A8826E9D353F702CB:::B29585A08F3C403A8826E9D353F702CB</MachineId> <MalwareGroup>Anti-Malware Testfile</MalwareGroup> <PathName>?:\users\user2\desktop</PathName> </GetThreatHistoryResponseModel_Record> </ThreatRecords> </GetThreatHistoryResponseModel>