Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/blockedurls/data
?includeDeactivated={includeDeactivated}
&includeHidden={includeHidden}
&pageNr={pageNr}
&pageSize={pageSize}
&startDate={startDate}
&endDate={endDate}

Retrieves a list of recorded URL actions on endpoints in the given site.

NOTE: Blocked URLs data is generally available for as far as 90 days in the past. However, the maximum allowed time range between 'startDate' and 'endDate' is 30 days.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required
includeDeactivated	Value indicating whether URL actions of endpoints that are currently deactivated should be included in the response.	boolean	Default is false
includeHidden	Value indicating whether URL actions of endpoints that are currently hidden should be included in the response.	boolean	Default is false
pageNr	The number of the page of data which should be returned.	integer	Default value is 1
pageSize	The number of data entries which should be returned for the page. Valid values are between 50 and 1000.	integer	Default value is 100
startDate	The start date of the time range for which data is queried.	date	Default value is endDate minus 24 hours
endDate	The end date of the time range for which data is queried.	date	Default value is the current date and time.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/blockedurls/data
GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/blockedurls/data?startDate=2020-09-01&endDate=2020-09-30&pageSize=100&pageNr=3

Body Parameters

None.

Response Information

Resource Description

Detail information about recorded URL actions.

GetBlockedURLsDataResponse

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 URL action records.	boolean	None.
IncludeDeactivated	Value indicating whether URL actions of endpoints that are currently deactivated are included in the response.	boolean	None.
IncludeHidden	Value indicating whether URL actions of endpoints that are currently hidden are included in the response.	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.
BlockedURLs	List of blocked URLs and related URL actions.	Collection of GetBlockedURLsDataResponseBlockedURL	None.

Sample Response

{
  "MoreAvailable": false,
  "IncludeDeactivated": false,
  "IncludeHidden": false,
  "PageNr": 1,
  "PageSize": 100,
  "StartDate": "2024-04-24T13:38:13.7376168Z",
  "EndDate": "2024-04-25T13:38:13.7376168Z",
  "BlockedURLs": [
    {
      "BlockedUrl": "https://www.suspicious.com/page0.html",
      "BlockReasonId": 48,
      "BlockReasonName": "Violence",
      "BCRI": null,
      "Timestamp": "2024-04-25T13:38:11.7376168Z",
      "ActionTaken": "WHITELIST",
      "HostName": "Computer0",
      "EndpointId": "fd69623d-87b8-4e38-b7b6-8ebf8fbfb1a4"
    },
    {
      "BlockedUrl": "https://www.malicious.com/page0.html",
      "BlockReasonId": 48,
      "BlockReasonName": "Violence",
      "BCRI": 0,
      "Timestamp": "2024-04-25T13:37:29.7376168Z",
      "ActionTaken": "BLOCK",
      "HostName": "Computer0",
      "EndpointId": "7477ad41-b1ac-4330-8de5-5f97b7de4c67"
    }
  ]
}

<GetBlockedURLsDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.BDAPI">
  <BlockedURLs>
    <GetBlockedURLsDataResponseBlockedURL>
      <ActionTaken>WHITELIST</ActionTaken>
      <BCRI i:nil="true" />
      <BlockReasonId>48</BlockReasonId>
      <BlockReasonName>Violence</BlockReasonName>
      <BlockedUrl>https://www.suspicious.com/page0.html</BlockedUrl>
      <EndpointId>fd69623d-87b8-4e38-b7b6-8ebf8fbfb1a4</EndpointId>
      <HostName>Computer0</HostName>
      <Timestamp>2024-04-25T13:38:11.7376168Z</Timestamp>
    </GetBlockedURLsDataResponseBlockedURL>
    <GetBlockedURLsDataResponseBlockedURL>
      <ActionTaken>BLOCK</ActionTaken>
      <BCRI>0</BCRI>
      <BlockReasonId>48</BlockReasonId>
      <BlockReasonName>Violence</BlockReasonName>
      <BlockedUrl>https://www.malicious.com/page0.html</BlockedUrl>
      <EndpointId>7477ad41-b1ac-4330-8de5-5f97b7de4c67</EndpointId>
      <HostName>Computer0</HostName>
      <Timestamp>2024-04-25T13:37:29.7376168Z</Timestamp>
    </GetBlockedURLsDataResponseBlockedURL>
  </BlockedURLs>
  <EndDate>2024-04-25T13:38:13.7376168Z</EndDate>
  <IncludeDeactivated>false</IncludeDeactivated>
  <IncludeHidden>false</IncludeHidden>
  <MoreAvailable>false</MoreAvailable>
  <PageNr>1</PageNr>
  <PageSize>100</PageSize>
  <StartDate>2024-04-24T13:38:13.7376168Z</StartDate>
</GetBlockedURLsDataResponse>

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/blockedurls/data ?includeDeactivated={includeDeactivated} &includeHidden={includeHidden} &pageNr={pageNr} &pageSize={pageSize} &startDate={startDate} &endDate={endDate}