Configure server services - BlueCat Address Manager - 9.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.3.0

Configure multiple DNS/DHCP Servers with a defined set of service configurations in JSON format.

For examples of the different service configuration JSON formats, refer to Reference: Server service configuration example.

API method: POST /v1/configureServerServices
Attention:
  • You must be an administrator to use this API.
  • You cannot run concurrent configureServerServices API calls to configure multiple services on the same DNS/DHCP Server.
  • If you use the response from the getServerServices API to help construct the JSON body content of the configureServerServices API, some content returned from the getServerServices response might not be complete or compatible within the configureServerServices JSON body, such as the server-version field. BlueCat recommends using a JSON validation tool to validate the response of the getServerServices API and reviewing the examples of valid service configuration JSON body content before proceeding to update the response for use within the JSON body of the configureServerServices API method. For examples of valid configuration JSON body content for each server service, refer to Reference: Server service configuration example.

When configuring large amounts of DNS/DHCP Servers, the configureServerServices API method configures 20 DNS/DHCP Servers at a time. Once a DNS/DHCP Server has finished configuring, the next DNS/DHCP Server is added to the end of the list. You can use the getServerServicesConfigurationStatus API method to retrieve the updated list of DNS/DHCP Servers that are currently being configured.