Reference: DNS Option value formats - BlueCat Address Manager - 8.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.3.0

The input and output value formats for DNS Option API methods.

When performing an add operation of DNS 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:

Input
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:

Output
{
  "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:

Input
logn 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 getDeploymentOption API method would return values similar to the following:

Output
{
  "id": 100977,
  "type": "DNS",
  "name": "cache",
  "value": "{admin.corp,172.25.19.53}",
  "properties": "inherited=false|"
}
Note: When adding a Root Hint DNS deployment option with the value of "Auto", the value defined in the add API method must be empty double quotation marks and braces ("{}"). Similarly, when performing a get API method of DNS deployment options where the Root Hint has a value of "Auto", the value returned is empty double quotation marks and braces ("{}").