Documentation

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

Returns a list of available DNS Protection policies and their respective identifiers for a GSM parent keycode.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/D5B9-B625-CAA9-47A7-91B6/dnsp/policies

Body Parameters

None.

Response Information

Resource Description

Information about DNS Protection policies.

GetDNSPGlobalPoliciesResponseModel

Name	Description	Type	Additional Information
TotalCount	Total number of policies available.	integer	None.
Policies	The list of policies.	Collection of GetDNSPGlobalPoliciesResponseModel_Policy	None.

Sample Response

{
  "TotalCount": 2,
  "Policies": [
    {
      "Id": "cb5e80a6-0648-4b4e-9dcd-8d36278758a4",
      "Name": "Test Policy 1",
      "BlockedCategories": [
        50,
        57,
        58,
        59,
        60,
        68
      ],
      "Editable": true,
      "CreatedDate": "2024-12-08T19:07:05.6009902Z",
      "ModifiedDate": "2024-12-08T19:07:05.6009902Z"
    },
    {
      "Id": "10226905-1037-4a6b-887a-475729e9dce2",
      "Name": "Test Policy 2",
      "BlockedCategories": [
        51,
        58,
        59,
        60,
        61,
        69
      ],
      "Editable": true,
      "CreatedDate": "2024-07-08T19:07:05.6009902Z",
      "ModifiedDate": "2024-07-08T19:07:05.6009902Z"
    }
  ]
}

<GetDNSPGlobalPoliciesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Policies>
    <GetDNSPGlobalPoliciesResponseModel_Policy>
      <BlockedCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>50</d4p1:int>
        <d4p1:int>57</d4p1:int>
        <d4p1:int>58</d4p1:int>
        <d4p1:int>59</d4p1:int>
        <d4p1:int>60</d4p1:int>
        <d4p1:int>68</d4p1:int>
      </BlockedCategories>
      <CreatedDate>2024-12-08T19:07:05.6009902Z</CreatedDate>
      <Editable>true</Editable>
      <Id>cb5e80a6-0648-4b4e-9dcd-8d36278758a4</Id>
      <ModifiedDate>2024-12-08T19:07:05.6009902Z</ModifiedDate>
      <Name>Test Policy 1</Name>
    </GetDNSPGlobalPoliciesResponseModel_Policy>
    <GetDNSPGlobalPoliciesResponseModel_Policy>
      <BlockedCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>51</d4p1:int>
        <d4p1:int>58</d4p1:int>
        <d4p1:int>59</d4p1:int>
        <d4p1:int>60</d4p1:int>
        <d4p1:int>61</d4p1:int>
        <d4p1:int>69</d4p1:int>
      </BlockedCategories>
      <CreatedDate>2024-07-08T19:07:05.6009902Z</CreatedDate>
      <Editable>true</Editable>
      <Id>10226905-1037-4a6b-887a-475729e9dce2</Id>
      <ModifiedDate>2024-07-08T19:07:05.6009902Z</ModifiedDate>
      <Name>Test Policy 2</Name>
    </GetDNSPGlobalPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetDNSPGlobalPoliciesResponseModel>