Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/dnsp/blockedtraffic
?startDate={startDate}
&endDate={endDate}
&pageSize={pageSize}
&pageNr={pageNr}

Returns information about DNS requests that were blocked by the DNS Protection service.

NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.

WARNING: The maximum number of returned traffic records is limited to ensure that requests can complete in reasonable time. The amount of data accumulating over an increasing timespan can become very large, reaching into the millions of records for the maximum allowed time interval of 30 days. When querying blocked traffic for high-use sites, it is advised to query more regularly for shorter periods of time, instead of trying to pull the entire data once per month only.

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 blocked requests after (or at) the given date. If omitted, defaults to 'endDate' minus 24 hours.	date	None.
endDate	If specified, returns blocked requests before (or at) the given date. If omitted, defaults to the current date and time.	date	None.
pageSize	Specifies the maximum number of records to return. Valid values are between 100 and 10000.	integer	Default value is 1000
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/B60B-F551-6EEB-48E8-B940/sites/632fed87-5fff-4149-bbf2-508ca826944c/dnsp/blockedtraffic?startDate=2023-05-07T05:21:07.4910351Z&endDate=2023-06-06T05:21:07.4910351Z&pageSize=100&pageNr=4

Body Parameters

None.

Response Information

Resource Description

Information about DNS requests that were blocked by the DNS Protection service.

GetDNSPBlockedTrafficResponseModel

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 blocked request 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	The start date that was used for the data query.	date	None.
EndDate	The end date that was used for the data query.	date	None.
SiteId	The identifier of the GSM site traffic information was queried for.	string	None.
SiteName	The name of the GSM site traffic information was queried for.	string	None.
BlockedRequests	The list of blocked request records.	Collection of GetDNSPBlockedTrafficResponseModel_DNSRequest	None.

Sample Response

{
  "MoreAvailable": false,
  "PageNr": 1,
  "PageSize": 1000,
  "StartDate": "2023-06-05T05:21:09.2566665Z",
  "EndDate": "2023-06-06T05:21:09.2566665Z",
  "SiteId": "e331910e-88af-43e5-82e7-40e9426b5b1f",
  "SiteName": "Site 1",
  "BlockedRequests": [
    {
      "Timestamp": "2023-06-06T05:20:09.2566665Z",
      "HostName": "MyComputer1",
      "UserName": "User1",
      "AgentVersion": "1.2.1.28",
      "SourceIp": "95.7.231.223",
      "Domain": "www.blocked-domain1.com",
      "DomainIps": [
        "95.134.71.175",
        "95.178.21.92"
      ],
      "CategoryIds": [
        50,
        57
      ],
      "BlockReasonId": 0
    },
    {
      "Timestamp": "2023-06-06T05:19:09.2566665Z",
      "HostName": "MyComputer2",
      "UserName": "User2",
      "AgentVersion": "1.2.1.28",
      "SourceIp": "95.159.22.186",
      "Domain": "www.blocked-domain2.com",
      "DomainIps": [
        "95.219.30.157",
        "95.8.52.244"
      ],
      "CategoryIds": [
        51,
        58
      ],
      "BlockReasonId": 4
    }
  ]
}

<GetDNSPBlockedTrafficResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <BlockedRequests>
    <GetDNSPBlockedTrafficResponseModel_DNSRequest>
      <AgentVersion>1.2.1.28</AgentVersion>
      <BlockReasonId>0</BlockReasonId>
      <CategoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>50</d4p1:int>
        <d4p1:int>57</d4p1:int>
      </CategoryIds>
      <Domain>www.blocked-domain1.com</Domain>
      <DomainIps xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>95.134.71.175</d4p1:string>
        <d4p1:string>95.178.21.92</d4p1:string>
      </DomainIps>
      <HostName>MyComputer1</HostName>
      <SourceIp>95.7.231.223</SourceIp>
      <Timestamp>2023-06-06T05:20:09.2566665Z</Timestamp>
      <UserName>User1</UserName>
    </GetDNSPBlockedTrafficResponseModel_DNSRequest>
    <GetDNSPBlockedTrafficResponseModel_DNSRequest>
      <AgentVersion>1.2.1.28</AgentVersion>
      <BlockReasonId>4</BlockReasonId>
      <CategoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>51</d4p1:int>
        <d4p1:int>58</d4p1:int>
      </CategoryIds>
      <Domain>www.blocked-domain2.com</Domain>
      <DomainIps xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>95.219.30.157</d4p1:string>
        <d4p1:string>95.8.52.244</d4p1:string>
      </DomainIps>
      <HostName>MyComputer2</HostName>
      <SourceIp>95.159.22.186</SourceIp>
      <Timestamp>2023-06-06T05:19:09.2566665Z</Timestamp>
      <UserName>User2</UserName>
    </GetDNSPBlockedTrafficResponseModel_DNSRequest>
  </BlockedRequests>
  <EndDate>2023-06-06T05:21:09.2566665Z</EndDate>
  <MoreAvailable>false</MoreAvailable>
  <PageNr>1</PageNr>
  <PageSize>1000</PageSize>
  <SiteId>e331910e-88af-43e5-82e7-40e9426b5b1f</SiteId>
  <SiteName>Site 1</SiteName>
  <StartDate>2023-06-05T05:21:09.2566665Z</StartDate>
</GetDNSPBlockedTrafficResponseModel>

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/dnsp/blockedtraffic ?startDate={startDate} &endDate={endDate} &pageSize={pageSize} &pageNr={pageNr}