Info

Query the health of the node.

Changed on

Get node health information. A node is considered healthy if its Stacks tip height matches the maximum Stacks tip height observed among its connected peers. This endpoint returns:

  • difference_from_max_peer: The difference in Stacks height between this node and its most advanced peer.
  • max_stacks_height_of_neighbors: The maximum Stacks height observed among the node"s connected peers.
  • node_stacks_tip_height: The current Stacks tip height of this node.
  • max_stacks_neighbor_address: The address of the most advanced peer. Null if no peer data is available.
get/v3/health

Request

  • Base URL
    http://localhost:20443
  • URL
    http://localhost:20443/v3/health
  • Auth
    none required

Response

Success

GetHealth required(unresolved $ref)

Changes

  • a9c44dcce761Revision changes
    • warning

      deleted the query request parameter neighbors

  • 04a9a0b50aa3Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      api operation id get_health removed and replaced with getNodeHealth

    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status