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
|
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/threathistory
|
|
GET
|
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/threathistory?returnedInfo=ExtendedInfo
|
|
GET
|
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": "2019-11-25T09:07:18.7692145Z",
"EndDate": "2020-02-25T09:07:18.7692145Z",
"ThreatRecords": [
{
"EndpointId": "7395924c-3275-4577-afa5-a96e398ef132",
"MachineId": "D3936B0530D64F899FAEF2BDA007E124:::E482DBF345CB4141AC8687931490F01B:::E482DBF345CB4141AC8687931490F01B",
"HostName": "MyComputer1",
"FileName": "eicar.com",
"PathName": "?:\\users\\user1\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2020-02-12T09:07:18.7692145Z",
"LastSeen": "2020-02-23T09:07:18.7692145Z",
"ExtendedInfo": {
"DwellTime": 516,
"FileMD5": "021DB0EF43154A189254597A42C6DDA1",
"FileSize": 68,
"UserName": "User1",
"IPAddress": "95.239.212.248",
"Determination": "B",
"FileVendor": "",
"FileProduct": "",
"FileVersion": ""
}
},
{
"EndpointId": "c3709ba1-28b6-421f-b6c4-f9e0be233164",
"MachineId": "486FA68BE42B4EA2858A069CBD5B036C:::F0690AD65DC74FB9961E5BF67946017A:::F0690AD65DC74FB9961E5BF67946017A",
"HostName": "MyComputer2",
"FileName": "eicar.com",
"PathName": "?:\\users\\user2\\desktop",
"MalwareGroup": "Anti-Malware Testfile",
"FirstSeen": "2020-02-12T09:07:18.7692145Z",
"LastSeen": "2020-02-23T09:07:18.7692145Z",
"ExtendedInfo": {
"DwellTime": 133,
"FileMD5": "8245867F997C4BB99624333E24C012C6",
"FileSize": 68,
"UserName": "User2",
"IPAddress": "95.53.15.21",
"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>2020-02-25T09:07:18.7692145Z</EndDate>
<MoreAvailable>false</MoreAvailable>
<PageNr>1</PageNr>
<PageSize>50</PageSize>
<StartDate>2019-11-25T09:07:18.7692145Z</StartDate>
<ThreatRecords>
<GetThreatHistoryResponseModel_Record>
<EndpointId>7395924c-3275-4577-afa5-a96e398ef132</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>516</DwellTime>
<FileMD5>021DB0EF43154A189254597A42C6DDA1</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.239.212.248</IPAddress>
<UserName>User1</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2020-02-12T09:07:18.7692145Z</FirstSeen>
<HostName>MyComputer1</HostName>
<LastSeen>2020-02-23T09:07:18.7692145Z</LastSeen>
<MachineId>D3936B0530D64F899FAEF2BDA007E124:::E482DBF345CB4141AC8687931490F01B:::E482DBF345CB4141AC8687931490F01B</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user1\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
<GetThreatHistoryResponseModel_Record>
<EndpointId>c3709ba1-28b6-421f-b6c4-f9e0be233164</EndpointId>
<ExtendedInfo>
<Determination>B</Determination>
<DwellTime>133</DwellTime>
<FileMD5>8245867F997C4BB99624333E24C012C6</FileMD5>
<FileProduct></FileProduct>
<FileSize>68</FileSize>
<FileVendor></FileVendor>
<FileVersion></FileVersion>
<IPAddress>95.53.15.21</IPAddress>
<UserName>User2</UserName>
</ExtendedInfo>
<FileName>eicar.com</FileName>
<FirstSeen>2020-02-12T09:07:18.7692145Z</FirstSeen>
<HostName>MyComputer2</HostName>
<LastSeen>2020-02-23T09:07:18.7692145Z</LastSeen>
<MachineId>486FA68BE42B4EA2858A069CBD5B036C:::F0690AD65DC74FB9961E5BF67946017A:::F0690AD65DC74FB9961E5BF67946017A</MachineId>
<MalwareGroup>Anti-Malware Testfile</MalwareGroup>
<PathName>?:\users\user2\desktop</PathName>
</GetThreatHistoryResponseModel_Record>
</ThreatRecords>
</GetThreatHistoryResponseModel>