Unity API Documentation

GET /service/api/console/gsm/{gsmKey}/dnsp/blockreasons

Returns a list of available DNS Protection block reasons and their respective identifiers.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/8246-D496-6BF8-4FCC-B592/dnsp/blockreasons

Body Parameters

None.

Response Information

Resource Description

Information about DNS Protection block reasons.

GetDNSPBlockReasonsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Number of block reasons in the BlockReasons array.

 integer

None.
BlockReasons

The list of block reasons.

 Collection of GetDNSPBlockReasonsResponseModel_Reason

None.

Sample Response

{
  "TotalCount": 5,
  "BlockReasons": [
    {
      "Id": 0,
      "Name": "Allowed",
      "Description": "This request for domain is allowed based on the policy settings of your organization"
    },
    {
      "Id": 1,
      "Name": "Override - Block",
      "Description": "This request for domain is blocked based on an override set for your organization"
    },
    {
      "Id": 2,
      "Name": "Blocked Category",
      "Description": "This request for domain is blocked based on Category blocking set for your organization"
    },
    {
      "Id": 3,
      "Name": "Block By Reputation",
      "Description": "This request for domain is blocked based on reputation score"
    },
    {
      "Id": 4,
      "Name": "Override - Allow",
      "Description": "This request for domain is allowed based on an override set for your organization"
    }
  ]
}                    
<GetDNSPBlockReasonsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <BlockReasons>
    <GetDNSPBlockReasonsResponseModel_Reason>
      <Description>This request for domain is allowed based on the policy settings of your organization</Description>
      <Id>0</Id>
      <Name>Allowed</Name>
    </GetDNSPBlockReasonsResponseModel_Reason>
    <GetDNSPBlockReasonsResponseModel_Reason>
      <Description>This request for domain is blocked based on an override set for your organization</Description>
      <Id>1</Id>
      <Name>Override - Block</Name>
    </GetDNSPBlockReasonsResponseModel_Reason>
    <GetDNSPBlockReasonsResponseModel_Reason>
      <Description>This request for domain is blocked based on Category blocking set for your organization</Description>
      <Id>2</Id>
      <Name>Blocked Category</Name>
    </GetDNSPBlockReasonsResponseModel_Reason>
    <GetDNSPBlockReasonsResponseModel_Reason>
      <Description>This request for domain is blocked based on reputation score</Description>
      <Id>3</Id>
      <Name>Block By Reputation</Name>
    </GetDNSPBlockReasonsResponseModel_Reason>
    <GetDNSPBlockReasonsResponseModel_Reason>
      <Description>This request for domain is allowed based on an override set for your organization</Description>
      <Id>4</Id>
      <Name>Override - Allow</Name>
    </GetDNSPBlockReasonsResponseModel_Reason>
  </BlockReasons>
  <TotalCount>5</TotalCount>
</GetDNSPBlockReasonsResponseModel>