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

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

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about DNS Protection policies.

GetDNSPGlobalPoliciesResponseModel
NameDescriptionTypeAdditional 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": "7d950ad0-5ff5-4240-926b-b710652daf89",
      "Name": "Test Policy 1",
      "BlockedCategories": [
        50,
        57,
        58,
        59,
        60,
        68
      ],
      "Editable": true,
      "CreatedDate": "2018-12-22T21:42:29.0798257Z",
      "ModifiedDate": "2018-12-22T21:42:29.0798257Z"
    },
    {
      "Id": "e674c688-7cfa-4024-9012-91b0035ce15d",
      "Name": "Test Policy 2",
      "BlockedCategories": [
        51,
        58,
        59,
        60,
        61,
        69
      ],
      "Editable": true,
      "CreatedDate": "2018-07-22T21:42:29.0798257Z",
      "ModifiedDate": "2018-07-22T21:42:29.0798257Z"
    }
  ]
}                    
<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>2018-12-22T21:42:29.0798257Z</CreatedDate>
      <Editable>true</Editable>
      <Id>7d950ad0-5ff5-4240-926b-b710652daf89</Id>
      <ModifiedDate>2018-12-22T21:42:29.0798257Z</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>2018-07-22T21:42:29.0798257Z</CreatedDate>
      <Editable>true</Editable>
      <Id>e674c688-7cfa-4024-9012-91b0035ce15d</Id>
      <ModifiedDate>2018-07-22T21:42:29.0798257Z</ModifiedDate>
      <Name>Test Policy 2</Name>
    </GetDNSPGlobalPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetDNSPGlobalPoliciesResponseModel>