The input and output value formats for deployment option API methods.
Example deployment option value formats
| Value type | Description | Value format | Example deployment option |
|---|---|---|---|
| Single value | A single value provided. |
first |
forwarding-policy |
| Multiple value | Multiple values that are separated by commas. |
1.1.1.1,2.2.2.2 |
allow-notify |
| Two-dimensional values | A two-dimensional array that is contained within braces and separated by commas. The values within each set are also separated by commas. |
{grant,test,subdomain, sub.domain.com,ANY} , {grant,test2,self, domain.com,ANY}
Note: If configuring an update-policy with Custom resource record types,
the resource record types are separated by spaces. The following example
displays the value format:
{grant,test,subdomain, sub.domain.com,NS MF} , {grant,test2,self, domain.com,ANY}
|
update-policy |
DNS deployment option value format exception
When performing an add operation of deployment options, the value input is in double quotation marks (""). For example, adding a Lame TTL DNS deployment option with a value of "300" using the addDNSDeploymentOption API method to Address Manager would look similar to the following:
long optId = service.addDNSDeploymentOption(100977, DNSOptions.LAME_TTL, "300", "");
Similarly, retrieving a Lame TTL DNS deployment option with a value of "300" using the getDeploymentOptions API method would return values similar to the following:
{
"id": 100977,
"type": "DNS",
"name": "lame-ttl",
"value": "300",
"properties": "inherited=false|"
}
Exception - When performing an add, update, or get API call with the Root Hints (CACHE) DNS deployment option, the value input is in double quotation marks and braces ("{}"). For example, adding a Root Hint DNS deployment option with a specified name value of "admin.corp" and IP address of 172.25.19.53 using the addDNSDeploymentOption API method would look similar to the following:
long optId = service.addDNSDeploymentOption(100977, DNSOptions.CACHE, "{admin.corp,172.25.19.53}","");
Similarly, retrieving a Root Hint DNS deployment option with a specified name value of "admin.corp" and IP address of 172.25.19.53 using the getDeploymentOptions API method would return values similar to the following:
{
"id": 100977,
"type": "DNS",
"name": "cache",
"value": "{admin.corp,172.25.19.53}",
"properties": "inherited=false|"
}