Manipulating Address Manager objects - BlueCat Integrity - 9.3.0

Address Manager API Guide

Product name
BlueCat Integrity

DNS and network information in Address Manager are arranged as a hierarchy of objects, beginning with the Address Manager server itself at the highest level. If an object contains child objects, those objects inherit any access rights and overrides you set on their parent. For example, access rights set on an IPv4 network are inherited by the IPv4 DHCP ranges and IPv4 addresses within the network.

You can assign Address Manager access rights to both users and groups, and multiple rights can exist for the same object. A single user may have both an access right and multiple overrides on an object, while multiple users could also have access rights and overrides on the same object. Three rules determine a user’s access rights for any object within Address Manager:
  • Administrators always have full control over any system object.
  • The most local access right takes precedence over any other rights assigned higher in the object hierarchy.
  • In the case of conflicting access rights for an object, the most permissive access right always takes precedence.
Through the Address Manager API, you can remotely manipulate objects using a combination of generic and type-specific methods. Using various API methods, you can:
  • Add objects
  • Update objects
  • Get objects by name
  • Add child objects to parent objects
  • Add access rights to objects
  • Add object tags to objects
  • Delete objects
The Address Manager API also includes various query functions, such as a check to see if an IP address is allocated. To access the Address Manager API, the script or application must log in to Address Manager as an API user.