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
|
api/console/gsm/0871-D05C-7601-495C-8BEE/sites/4714143f-d386-4734-9934-95826ed26fd2/dnsp/blockedtraffic?startDate=2020-01-26T07:11:06.2832803Z&endDate=2020-02-25T07:11:06.2832803Z&pageSize=100&pageNr=9
|
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": "2020-02-24T12:07:15.2939212Z",
"EndDate": "2020-02-25T12:07:15.2939212Z",
"SiteId": "9cc96764-b73b-4fba-8178-75267e9556cd",
"SiteName": "Site 1",
"BlockedRequests": [
{
"Timestamp": "2020-02-25T12:06:15.2939212Z",
"HostName": "MyComputer1",
"UserName": "User1",
"AgentVersion": "1.2.1.28",
"SourceIp": "95.65.40.87",
"Domain": "www.blocked-domain1.com",
"DomainIps": [
"95.23.200.48",
"95.243.73.74"
],
"CategoryIds": [
50,
57
],
"BlockReasonId": 0
},
{
"Timestamp": "2020-02-25T12:05:15.2939212Z",
"HostName": "MyComputer2",
"UserName": "User2",
"AgentVersion": "1.2.1.28",
"SourceIp": "95.35.98.142",
"Domain": "www.blocked-domain2.com",
"DomainIps": [
"95.201.199.15",
"95.3.115.185"
],
"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.23.200.48</d4p1:string>
<d4p1:string>95.243.73.74</d4p1:string>
</DomainIps>
<HostName>MyComputer1</HostName>
<SourceIp>95.65.40.87</SourceIp>
<Timestamp>2020-02-25T12:06:15.2939212Z</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.201.199.15</d4p1:string>
<d4p1:string>95.3.115.185</d4p1:string>
</DomainIps>
<HostName>MyComputer2</HostName>
<SourceIp>95.35.98.142</SourceIp>
<Timestamp>2020-02-25T12:05:15.2939212Z</Timestamp>
<UserName>User2</UserName>
</GetDNSPBlockedTrafficResponseModel_DNSRequest>
</BlockedRequests>
<EndDate>2020-02-25T12:07:15.2939212Z</EndDate>
<MoreAvailable>false</MoreAvailable>
<PageNr>1</PageNr>
<PageSize>1000</PageSize>
<SiteId>9cc96764-b73b-4fba-8178-75267e9556cd</SiteId>
<SiteName>Site 1</SiteName>
<StartDate>2020-02-24T12:07:15.2939212Z</StartDate>
</GetDNSPBlockedTrafficResponseModel>