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.
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/A4D9-ACC7-5E5A-4037-8226/sites/fdeea8f0-1676-43d4-8316-49cca5e34d86/dnsp/blockedtraffic?startDate=2024-08-08T18:57:19.1815710Z&endDate=2024-09-07T18:57:19.1815710Z&pageSize=100&pageNr=49
|
Body Parameters
None.
Response Information
Resource Description
Information about DNS requests that were blocked by the DNS Protection service.
GetDNSPBlockedTrafficResponseModelName | 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": "2024-09-07T03:13:23.7402636Z", "EndDate": "2024-09-08T03:13:23.7402636Z", "SiteId": "bb459e7b-18e5-4e61-ab55-680112928f97", "SiteName": "Site 1", "BlockedRequests": [ { "Timestamp": "2024-09-08T03:12:23.7402636Z", "HostName": "MyComputer1", "UserName": "User1", "AgentVersion": "1.2.1.28", "SourceIp": "95.106.243.47", "Domain": "www.blocked-domain1.com", "DomainIps": [ "95.76.226.181", "95.185.170.111" ], "CategoryIds": [ 50, 57 ], "BlockReasonId": 2 }, { "Timestamp": "2024-09-08T03:11:23.7402636Z", "HostName": "MyComputer2", "UserName": "User2", "AgentVersion": "1.2.1.28", "SourceIp": "95.0.30.20", "Domain": "www.blocked-domain2.com", "DomainIps": [ "95.146.196.82", "95.188.37.47" ], "CategoryIds": [ 51, 58 ], "BlockReasonId": 2 } ] }
<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>2</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.76.226.181</d4p1:string> <d4p1:string>95.185.170.111</d4p1:string> </DomainIps> <HostName>MyComputer1</HostName> <SourceIp>95.106.243.47</SourceIp> <Timestamp>2024-09-08T03:12:23.7402636Z</Timestamp> <UserName>User1</UserName> </GetDNSPBlockedTrafficResponseModel_DNSRequest> <GetDNSPBlockedTrafficResponseModel_DNSRequest> <AgentVersion>1.2.1.28</AgentVersion> <BlockReasonId>2</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.146.196.82</d4p1:string> <d4p1:string>95.188.37.47</d4p1:string> </DomainIps> <HostName>MyComputer2</HostName> <SourceIp>95.0.30.20</SourceIp> <Timestamp>2024-09-08T03:11:23.7402636Z</Timestamp> <UserName>User2</UserName> </GetDNSPBlockedTrafficResponseModel_DNSRequest> </BlockedRequests> <EndDate>2024-09-08T03:13:23.7402636Z</EndDate> <MoreAvailable>false</MoreAvailable> <PageNr>1</PageNr> <PageSize>1000</PageSize> <SiteId>bb459e7b-18e5-4e61-ab55-680112928f97</SiteId> <SiteName>Site 1</SiteName> <StartDate>2024-09-07T03:13:23.7402636Z</StartDate> </GetDNSPBlockedTrafficResponseModel>