BlueCat Gateway - BlueCat Integrity - 9.4.0

Address Manager API Guide

Product name
BlueCat Integrity

By configuring BlueCat Gateway on a supported DNS/DHCP Server appliance, you can automate and transform mission-critical business requirements into DNS, DHCP, and IPAM workflows, and deploy value-add BlueCat Adaptive Applications and Plugins. Using zero-touch automation frees IT teams from time-consuming, error-prone, and repetitive network configuration and provisioning tasks so they can focus on the innovation your business needs. With everyday network tasks and functions automated and repetitive processes controlled and managed automatically, network service availability and application performance improves.

Attention: This service cannot be configured on DNS/DHCP Servers operating in an xHA pair.


  • username—enter the docker registry username if the image is on a private repository, for example, if pulling a BlueCat Adaptive Application.
  • password—enter the docker registry password. This can either be your Docker password or an encrypted password.
  • removeImage—set to true to remove the image; set to false to keep the image. As a best practice, BlueCat recommends removing the image as part of a container upgrade. This field is ignored if enable is set to true.
  • data—enter the BlueCat Gateway configuration information.
    • enable—set to true to enable BlueCat Gateway service; set to false to disable BlueCat Gateway service.
    • version—required for service configuration, can be left as 1.
    • containers—enter the BlueCat Gateway container instance information. Only a single container is supported.
      • environment—enter the Address Manager IP address on which to enable Gateway service. This field cannot be empty.
      • ports—enter the ports to be configured for the BlueCat Gateway instance. This field cannot be empty.
      • volumes—enter the directories that will be bind mounted to the container for data and logging (previously referred to as volumes). As a best practice, BlueCat recommends using the default directories listed in the example JSON. This field cannot be empty.
      • image—enter the name of the Docker image to load. This field cannot be empty.
      • name—enter the name of the BlueCat Gateway container instance.
Note: There are no API methods to start or stop the container. Gateway Service can only be configured, enabled, or disabled via the API. Enabling Gateway Service starts the container; disabling Gateway Service stops the container and stops Gateway Service.
Tip: If configuring the Gateway Service via API, BlueCat recommends keeping the default mounted data and logs directories in the gateway configuration. For Gateway Service on BDDS only, mounted directories are recommended to ensure data persistence when patching or upgrading BDDS.