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.
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": "2022-11-09T00:57:34.1940938Z",
"EndDate": "2023-02-09T00:57:34.1940938Z",
"ThreatRecords": [
{
"EndpointId": "a428715a-f940-4099-8dc8-d37eded28f3f",
"MachineId": "052A50988CE84BDA9CE18B18A3A5A577:::74DA4EECE0184ED78D07F6FE1CEAD2D1:::74DA4EECE0184ED78D07F6FE1CEAD2D1",
"HostName": "MyComputer1",
"FileName": "eicar.com",
"PathName": "?:\\users\\user1\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2023-01-27T00:57:34.1940938Z",
"LastSeen": "2023-02-07T00:57:34.1940938Z",
"ExtendedInfo": {
"DwellTime": 107,
"FileMD5": "550F57C27C504C4CA9ABE3BBBC9C2CA1",
"FileSize": 68,
"UserName": "User1",
"IPAddress": "95.250.110.79",
"Determination": "B",
"FileVendor": "",
"FileProduct": "",
"FileVersion": ""
}
},
{
"EndpointId": "761453a0-bf8f-47ae-a227-b06760b2f42f",
"MachineId": "CD0F6C38C4BD4278AC932BD1FFF345EB:::BD2463D20BCC4A16A776959CC39A0FCF:::BD2463D20BCC4A16A776959CC39A0FCF",
"HostName": "MyComputer2",
"FileName": "eicar.com",
"PathName": "?:\\users\\user2\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2023-01-27T00:57:34.1940938Z",
"LastSeen": "2023-02-07T00:57:34.1940938Z",
"ExtendedInfo": {
"DwellTime": 727,
"FileMD5": "6DA13A1FEC9A4E26AD46B9FC8892F2F6",
"FileSize": 68,
"UserName": "User2",
"IPAddress": "95.76.92.17",
"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>2023-02-09T00:57:34.1940938Z</EndDate>
<MoreAvailable>false</MoreAvailable>
<PageNr>1</PageNr>
<PageSize>50</PageSize>
<StartDate>2022-11-09T00:57:34.1940938Z</StartDate>
<ThreatRecords>
<GetThreatHistoryResponseModel_Record>
<EndpointId>a428715a-f940-4099-8dc8-d37eded28f3f</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>107</DwellTime>
<FileMD5>550F57C27C504C4CA9ABE3BBBC9C2CA1</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.250.110.79</IPAddress>
<UserName>User1</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2023-01-27T00:57:34.1940938Z</FirstSeen>
<HostName>MyComputer1</HostName>
<LastSeen>2023-02-07T00:57:34.1940938Z</LastSeen>
<MachineId>052A50988CE84BDA9CE18B18A3A5A577:::74DA4EECE0184ED78D07F6FE1CEAD2D1:::74DA4EECE0184ED78D07F6FE1CEAD2D1</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user1\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
<GetThreatHistoryResponseModel_Record>
<EndpointId>761453a0-bf8f-47ae-a227-b06760b2f42f</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>727</DwellTime>
<FileMD5>6DA13A1FEC9A4E26AD46B9FC8892F2F6</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.76.92.17</IPAddress>
<UserName>User2</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2023-01-27T00:57:34.1940938Z</FirstSeen>
<HostName>MyComputer2</HostName>
<LastSeen>2023-02-07T00:57:34.1940938Z</LastSeen>
<MachineId>CD0F6C38C4BD4278AC932BD1FFF345EB:::BD2463D20BCC4A16A776959CC39A0FCF:::BD2463D20BCC4A16A776959CC39A0FCF</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user2\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
</ThreatRecords>
</GetThreatHistoryResponseModel>