GET request example - BlueCat Address Manager - 9.1.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.1.0

All get-related API methods use the GET method in REST API. This example uses getDNSDeploymentOption to retrieve the DNS option.

API call example
http://<AddressManager_IP>/Services/REST/v1/getDNSDeploymentOption?entityId=101041&name=allow-ddns&serverId=100907

Authorization: BAMAuthToken: UTtSjMTQ1ODAzMTgzMDUxMzphcGk=
Content Type: application/JSON
Parameters
Parameter Description
entityId The object ID for the entity to which this deployment option is assigned.
name The name of the DNS option. This is a constant listed in DNS options.
serverId Specifies the server to which this option is assigned. To retrieve an option that has not been assigned to a server role, set this value to zero (0).

Successful response

A JSON (as defined in WADL) containing details of the DNS deployment option.
{  
    "id": 100979,
    "type": "DNS",
    "name": "allow-ddns",
    "value": "any", 
    "properties": "inherited=false|"
}