PUT /ag/api/v1/group/members - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway


Have the local Gateway node join an existing Availability group as a Secondary node.

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

  • Only external_ipv4_address (the External IPv4 address), external_port (the External port), external_scheme (the External scheme), and group_fqdn (FQDN) are valid as input parameters for this endpoint. All other Availability group settings are set by the Primary node.

  • If Availability group settings were already configured and saved on the local Gateway instance (such as with PUT /ag/api/v1/configuration), you do not need to include them in the set of input parameters when calling this endpoint.

    However, only settings that apply to Secondary nodes will be used (external_ipv4_address, external_port, external_scheme, and group_fqdn). All other settings will be inherited and overwritten by settings on the Primary node.

Output response: Message indicating success or failure.

Sample input request

Note: The following sample request illustrates all available input parameters. All parameters are optional.
PUT /ag/api/v1/group/members
Content-Type: application/json

    "external_ipv4_address": "",
    "external_port": 443,
    "external_scheme": "https",
    "group_fqdn": "test.com"

Sample output

HTTP/1.1 200 OK
Content-Type: application/json
    "message": "Member removed from availability group."