Unity API Documentation

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.

NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 3 calendar months.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "2020-02-24T19:46:37.2597458Z",
  "EndDate": "2020-05-24T19:46:37.2597458Z",
  "ThreatRecords": [
    {
      "EndpointId": "1def477e-157c-4317-9fb0-17fb8a366adb",
      "MachineId": "F82C72FB63B949898845E6D3D306E91F:::F2DA2FFCD33A414EB831EB40AE31498B:::F2DA2FFCD33A414EB831EB40AE31498B",
      "HostName": "MyComputer1",
      "FileName": "eicar.com",
      "PathName": "?:\\users\\user1\\desktop",
      "MalwareGroup": "Anti-Malware Testfile",
      "FirstSeen": "2020-05-11T19:46:37.2597458Z",
      "LastSeen": "2020-05-22T19:46:37.2597458Z",
      "ExtendedInfo": {
        "DwellTime": 346,
        "FileMD5": "CA644A17F90644B5BF699F8933213168",
        "FileSize": 68,
        "UserName": "User1",
        "IPAddress": "95.172.11.196",
        "Determination": "B",
        "FileVendor": "",
        "FileProduct": "",
        "FileVersion": ""
      }
    },
    {
      "EndpointId": "69ad3c6e-039d-48d7-ab31-259f6574fe4c",
      "MachineId": "A51B202F6EAA4B8CBDAD7774E2370A0C:::9B9A9BB57924444DBFC0E0FB95F5CA5E:::9B9A9BB57924444DBFC0E0FB95F5CA5E",
      "HostName": "MyComputer2",
      "FileName": "eicar.com",
      "PathName": "?:\\users\\user2\\desktop",
      "MalwareGroup": "Anti-Malware Testfile",
      "FirstSeen": "2020-05-11T19:46:37.2597458Z",
      "LastSeen": "2020-05-22T19:46:37.2597458Z",
      "ExtendedInfo": {
        "DwellTime": 810,
        "FileMD5": "2EDA9A254C564134B1304ACE5004E65A",
        "FileSize": 68,
        "UserName": "User2",
        "IPAddress": "95.25.108.242",
        "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-05-24T19:46:37.2597458Z</EndDate>
  <MoreAvailable>false</MoreAvailable>
  <PageNr>1</PageNr>
  <PageSize>50</PageSize>
  <StartDate>2020-02-24T19:46:37.2597458Z</StartDate>
  <ThreatRecords>
    <GetThreatHistoryResponseModel_Record>
      <EndpointId>1def477e-157c-4317-9fb0-17fb8a366adb</EndpointId>
      <ExtendedInfo>
        <Determination>B</Determination>
        <DwellTime>346</DwellTime>
        <FileMD5>CA644A17F90644B5BF699F8933213168</FileMD5>
        <FileProduct></FileProduct>
        <FileSize>68</FileSize>
        <FileVendor></FileVendor>
        <FileVersion></FileVersion>
        <IPAddress>95.172.11.196</IPAddress>
        <UserName>User1</UserName>
      </ExtendedInfo>
      <FileName>eicar.com</FileName>
      <FirstSeen>2020-05-11T19:46:37.2597458Z</FirstSeen>
      <HostName>MyComputer1</HostName>
      <LastSeen>2020-05-22T19:46:37.2597458Z</LastSeen>
      <MachineId>F82C72FB63B949898845E6D3D306E91F:::F2DA2FFCD33A414EB831EB40AE31498B:::F2DA2FFCD33A414EB831EB40AE31498B</MachineId>
      <MalwareGroup>Anti-Malware Testfile</MalwareGroup>
      <PathName>?:\users\user1\desktop</PathName>
    </GetThreatHistoryResponseModel_Record>
    <GetThreatHistoryResponseModel_Record>
      <EndpointId>69ad3c6e-039d-48d7-ab31-259f6574fe4c</EndpointId>
      <ExtendedInfo>
        <Determination>B</Determination>
        <DwellTime>810</DwellTime>
        <FileMD5>2EDA9A254C564134B1304ACE5004E65A</FileMD5>
        <FileProduct></FileProduct>
        <FileSize>68</FileSize>
        <FileVendor></FileVendor>
        <FileVersion></FileVersion>
        <IPAddress>95.25.108.242</IPAddress>
        <UserName>User2</UserName>
      </ExtendedInfo>
      <FileName>eicar.com</FileName>
      <FirstSeen>2020-05-11T19:46:37.2597458Z</FirstSeen>
      <HostName>MyComputer2</HostName>
      <LastSeen>2020-05-22T19:46:37.2597458Z</LastSeen>
      <MachineId>A51B202F6EAA4B8CBDAD7774E2370A0C:::9B9A9BB57924444DBFC0E0FB95F5CA5E:::9B9A9BB57924444DBFC0E0FB95F5CA5E</MachineId>
      <MalwareGroup>Anti-Malware Testfile</MalwareGroup>
      <PathName>?:\users\user2\desktop</PathName>
    </GetThreatHistoryResponseModel_Record>
  </ThreatRecords>
</GetThreatHistoryResponseModel>