New API Methods - BlueCat Address Manager - 9.3.0

Address Manager API Guide

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

Address Manager API v9.3.0 includes the following new methods:

  • Upload Response Policy File: Use uploadResponsePolicyFile to uploads a response policy file containing a list of fully qualified domain names (FQDNs). For more information, refer to POST /v1/uploadResponsePolicyFile.
    Note: The uploadResponsePolicyItems API has been deprecated and replaced by uploadResponsePolicyFile.
  • Configure Server Services: Use configureServerServices to configure multiple DNS/DHCP Servers with a set of service configurations in JSON format. For more information, refer to POST /v1/configureServerServices.
  • Configure Server Services Status: Use getServerServicesConfigurationStatus to retrieve the DNS/DHCP server service configuration status of the configuration task that you created using the configureServerService API method. For more information, refer to GET /v1/getServerServicesConfigurationStatus.
  • Get Server Services: Use getServerServices to retrieve a list of services configured on the specified DNS/DHCP Server. For more information, refer to GET /v1/getServerServices.
  • Add IPv4 Templates: Use addIP4Template to add an IPv4 template to the specified configuration. For more information, refer to POST /v1/addIP4Template.
    Note: The addIP4NetworkTemplate API has been deprecated and replaced by addIP4Template.
  • Assign IPv4 Templates: Use assignIP4Template to assign an IPv4 template to a specified IPv4 object. For more information, refer to POST /v1/assignIP4Template.
    Note: The assignIP4NetworkTemplate API has been deprecated and replaced by assignIP4Template.
  • Unassign IPv4 Templates: Use unassignIP4Template to unassign an IPv4 template from a specified IPv4 object. For more information, refer to POST /v1/unassignIP4Template.
    Note: The unassignIP4NetworkTemplate API has been deprecated and replaced by unassignIP4Template.
  • Apply IPv4 Templates: Use applyIP4Template to apply an IPv4 template to the specified IPv4 object. For more information, refer to POST /v1/applyIP4Template.
    Note: The applyIP4NetworkTemplate API has been deprecated and replaced by applyIP4Template.
  • Get Linked IPv4 Template Conflicts: Use getLinkedIP4ObjectConflicts to retrieve a list of conflicting IPv4 objects and deployment options in JSON format. For more information, refer to GET /v1/getLinkedIP4ObjectConflicts.
    Note: The getLinkedNetworkConflicts API has been deprecated and replaced by getLinkedIP4ObjectConflicts.
  • Add user-defined link: Use addUserDefinedLink to add a user-defined link definition. For more information, refer to POST /v1/addUserDefinedLink.
  • Get user-defined link: Use getUserDefinedLink to retrieve the link definition from the user-definition link type. For more information, refer to GET /v1/getUserDefinedLink.
  • Delete user-defined link: Use deleteUserDefinedLink to delete the user-defined link definition. For more information, refer to DELETE /v1/deleteUserDefinedLink.
  • Update user-defined link: Use updateUserDefinedLink to update a user-defined link definition. For more information, refer to PUT /v1/updateUserDefinedLink.
  • Link entities for user-defined link: Use linkEntitiesEx to establish a link between the specified source and destination Address Manager entities. For more information, refer to PUT /v1/linkEntitiesEx.
  • Unlink entities for user-defined link: Use unlinkEntitiesEx to remove the link between the specified source and destination Address Manager entities. For more information, refer to PUT /v1/unlinkEntitiesEx.
  • Get linked entities for user-defined link: Use getlinkEntitiesEx to retrieve an array of entity IDs linked using the given link type to the given source or destination entity ID. For more information, refer to GET /v1/getlinkEntitiesEx.
  • Get Address Manager health: Use failover/health to retrieve the health status of Address Manager.
  • Promote secondary Address Manager server: Use failover/promote to promote a secondary Address Manager server in the cluster to primary.
  • Notify DNS/DHCP Server: Use failover/notify-servers to notify DNS/DHCP Server of the new primary Address Manager server.
  • Configure Audit Log Export: Use configureAuditLogExport to configure Audit Log Export. For more information, refer to POST /v1/configureAuditLogExport.
  • Get Audit Log Export Status: Use getAuditLogExportStatus to retrieve the configuration status of the configuration task you created using the configureAuditLogExport API method. For more information, refer to GET /v1/getAuditLogExportStatus
  • Update Retention Settings: Use updateRetentionSettings to set or view the history retention settings. For more information, refer to POST /v1/updateRetentionSettings.