Unity API Documentation

PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}/dnsp/mappings/{mappingId}

Edits a specified mapping of a DNS Protection policy.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
siteId

The identifier of the site for which the mapping should be modified.

 string

Required
mappingId

The identifier of the mapping.

 string

Required

Body Parameters

Additional information for editing the policy mapping.

Either DNSPolicyId, Type and Value, or all properties need to be specified.

EditDNSPPolicyMappingRequestModel
NameDescriptionTypeAdditional Information
Type

The type of the mapping. The supported type is "StaticIP", which associates an IP address with a DNS Protection policy.

 string

If specified, Value needs to be specified too.
Value

The value of the mapping. For mappings of type "StaticIP" the value must be an IP address.

 string

If specified, Type needs to be specified too.
DNSPolicyId

The DNS Protection policy id to be set for the mapping.

 string

None.

Sample Request

{
  "Type": "StaticIP",
  "Value": "10.244.165.59",
  "DNSPolicyId": "19bf9d83-d0cd-4470-99e4-bf79eae31333"
}                    
<EditDNSPPolicyMappingRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <DNSPolicyId>19bf9d83-d0cd-4470-99e4-bf79eae31333</DNSPolicyId>
  <Type>StaticIP</Type>
  <Value>10.244.165.59</Value>
</EditDNSPPolicyMappingRequestModel>

Response Information

Resource Description

Information about the edited policy mapping.

EditDNSPPolicyMappingResponseModel
NameDescriptionTypeAdditional Information
Id

The mapping id.

 string

None.
Type

The type of the mapping.

 string

None.
Value

The value of the mapping. For mappings of type "StaticIP" the value is an IP address.

 string

None.
DNSPolicyId

The DNS Protection policy id assigned to the mapping.

 string

None.

Sample Response

{
  "Id": "e55956ee-425b-40ca-9d17-1ad57974a9c1",
  "Type": "StaticIP",
  "Value": "95.14.37.121",
  "DNSPolicyId": "5fecbd50-7085-4847-887f-538e6b859830"
}                    
<EditDNSPPolicyMappingResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <DNSPolicyId>5fecbd50-7085-4847-887f-538e6b859830</DNSPolicyId>
  <Id>e55956ee-425b-40ca-9d17-1ad57974a9c1</Id>
  <Type>StaticIP</Type>
  <Value>95.14.37.121</Value>
</EditDNSPPolicyMappingResponseModel>