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

Gateway Administration Guide

Product name
BlueCat Gateway


Update an existing Availability group configuration for a Gateway instance when it is the Primary or Secondary node of an Availability group.

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

Input request: Parameters for the Availability group configuration.

Note: 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, overwriting any existing settings.

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

    "allowed_absence_interval": 45,
    "group_fqdn_ttl": 20,
    "health_check_interval": 30,
    "health_report_interval": 14,
    "tsig_algorithm": "hmac-sha512",
    "tsig_name": "ag",
    "tsig_secret": "7cJjV7j1tDvjAOPYPinBxFT1HnmXrp/AiGM+fXf+YR52iimpsuR/BVZf+R9B5rFJ07sM8ioL9XyICcJ0XW0bsQ=="

Sample output message

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

    "message": "Availability group configuration updated."