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

Gateway Administration Guide

Product name
BlueCat Gateway


Cause a failover within the node's Availability group. This can be called on either the Primary or Secondary Gateway node:
  • On the Primary node: Tells the Primary node to yield its status, so that it becomes the Secondary node and the original Secondary node becomes the Primary.

  • On the Secondary node: Tells the Secondary node to take over as the Primary node.

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

Input request: None.

Output response: Message indicating the results of the request.

Sample output

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

    "message": "Manual failover completed."