POST /ag/api/v1/group - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway


Create a new Availability group with the local Gateway instance as the Primary node.

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


You can use the PUT /ag/api/v1/configuration endpoint to "preconfigure" Availability group settings before explicitly adding the local Gateway instance to an Availability group. If you do so, when you create the Availability group with this endpoint, you need include only parameters for settings that have not yet been saved on this Gateway instance.

  • You must include at least one input parameter when calling this endpoint (even if it specifies a setting saved previously).

  • The combination of previously-saved settings and settings you specify with this endpoint must include all Availability group settings. Any input parameters not previously configured and saved must be specified and included when calling this endpoint.

Input request: (Optional) Parameters for the Availability group configuration of the node.

Note: You do not need to include every input parameter setting, though you must include at least one. Settings you include as input parameters will be saved in the Availability group configuration, overwriting any existing settings. Other settings must have been already configured, such as with the PUT /ag/api/v1/configuration endpoint .

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.
POST /ag/api/v1/group
Content-Type: application/json

    "external_ipv4_address": "",
    "external_scheme": "https",
    "external_port": 443,
    "group_fqdn": "",
    "group_fqdn_ttl": 30,
    "tsig_name": "ag",
    "tsig_algorithm": "hmac-sha512",
    "tsig_secret": "7cJjV7j1tDvjAOPYPinBxFT1HnmXrp/AiGM+fXf+YR52iimpsuR/BVZf+R9B5rFJ07sM8ioL9XyICcJ0XW0bsQ==",
    "health_report_interval": 9,
    "health_check_interval": 20,
    "allowed_absence_interval": 40


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

  • external_scheme: The communication scheme used by the Availability group and its nodes. This can be http or https.

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

  • 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.

  • tsig_name: The name of the TSIG key to use for members of the Availability group.

  • tsig_algorithm: The encryption algorithm used by the Availability groups TSIG key.

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

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

  • 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).

  • allowed_absence_interval: How long the Secondary Gateway node waits after a heartbeat before deciding that the Primary node has failed (seconds).

Sample output message

HTTP/1.1 200 OK
Content-Type: application/json

    "message": "Availability group created."