GET /ag/api/v1/state - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway


Get the details of the state of the local node, with respect to Availability groups. This works much like the Python API function get_node_state().

Input parameters: None.

Output results: Details about the state of the node.

Sample output

  "heartbeat_method": "direct",
  "last_heartbeat_time": "2022-11-25T18:28:24+00:00",
  "last_updated": "2022-11-25T18:28:53+00:00",
  "node_dns_connection_state": "connected",
  "node_role": "primary"


  • heartbeat_method: How the last heartbeat was communicated between the Primary and Secondary nodes. This can be either direct (the Primary node sent a heartbeat message directly to the Secondary node) or dns (The Primary node updates a TXT record in the DNS server periodically with the heartbeat time. The Secondary node reads details about the last heartbeat from this TXT record to determine whether the Primary node is still alive.).

  • last_heartbeat_time: The timestamp of the last heartbeat from the Primary node.

  • last_updated: The timestamp of the last heartbeat check made by the Secondary node (if applicable).

  • node_dns_connection_state: Whether the node is connected or disconnected from the DNS server that is responsible for the Availaibility group. If not_applicable, then the node is not part of an Availability group.

  • node_role: The role played by the local node within an Availability group. This can be either primary, secondary, or not_in_group (the local node is not part of an Availability group).