PUT /ag/api/v1/configuration - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway


Update the Availability group configuration for the local Gateway instance when it is not in an Availability group.

This endpoint will fail if the local Gateway node is already a member of an Availability group.

You can use this endpoint to "preconfigure" Availability group settings before explicitly adding the local Gateway instance to an Availability group.

Input request: Parameters for the Availability group configuration.

  • You do not need to include every input parameter setting, though you must include at least one. Only settings you include as input parameters will be saved in the Availability group configuration. Other settings will be left as-is.

Output response: Message indicating success or failure.

Sample input request

The following sample request illustrates all available input parameters. Not all parameters need be included when calling this endpoint, though the request must include at least one.
    "allowed_absence_interval": 47,
    "external_ipv4_address": "",
    "external_port": 443,
    "external_scheme": "https",
    "group_fqdn": "gateway.example.net",
    "group_fqdn_ttl": 27,
    "health_check_interval": 25,
    "health_report_interval": 15,
    "tsig_algorithm": "hmac-sha512",
    "tsig_name": "ag",
    "tsig_secret": "7cJjV7j1tDvjAOPYPinBxFT1HnmXrp/AiGM+fXf+YR52iimpsuR/BVZf+R9B5rFJ07sM8ioL9XyICcJ0XW0bsQ=="


  • allowed_absence_interval: How long the Secondary Gateway node waits after a heartbeat before deciding that the Primary node has failed (seconds). If this timeout is exceeded, the Secondary node attempts to take over handling of Gateway requests. We recommend you use a multiple of the Standby check interval. By default, this is 60.

  • external_ipv4_address: The IPv4 address of the current node. This is used when the DNS host record points to this Gateway instance.

  • external_port: The port at which this Gateway instance (and the Availability group) should be reached.

  • external_scheme: The communication scheme used by the Availability group and its nodes. You can choose from http or https.

  • group_fqdn: The fully qualified domain name (FQDN) used to create the DNS host record that maps to the IP address of the Primary Gateway instance.

  • group_fqdn_ttl: The Time-to-live (TTL) for the host record in the DNS server for the Availability group, in seconds. This value tells a cache how long it can store the host record before refreshing the search to get an answer from the name server.

  • health_check_interval: The Standby check interval. The time between checks made by the Secondary Gateway node to see if the Primary node is still active (in seconds).

  • health_report_interval: The time between health reports sent by the Primary Gateway node (in seconds).

  • tsig_algorithm: The encryption algorithm used by the Availability groups TSIG key. You can choose from the following:
    • hmac-md5
    • hmac-sha1
    • hmac-sha256
    • hmac-sha512
    Note: The hmac-md5 algorithm has known attacks and vulnerabilities. We recommend hmac-sha256 or hmac-sha512 where possible.
  • tsig_name: The name of the TSIG key to use for members of the Availability group.

  • tsig_secret: The contents of the Secret key. The length depends on the chosen algorithm.

Sample output

HTTP/1.1 200 OK
Content-Type: application/json
  "message": "Availability group configuration created."