/sys/ha-status

The /sys/ha-status endpoint is used to check the HA status of a Vault cluster. It lists the active node and the peers that it's heard from since it became active.

HA status

This endpoint returns the HA status of the Vault cluster.

Method	Path
`GET`	`/sys/ha-status`

Sample request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/ha-status

Sample response

{
  "Nodes": [
    {
      "active_node": true,
      "api_address": "http://10.0.0.2:8200",
      "clock_skew_ms": 0,
      "cluster_address": "https://10.0.0.2:8201",
      "echo_duration_ms": 0,
      "hostname": "node1",
      "last_echo": null,
      "replication_primary_canary_age_ms": 0,
      "version": "1.17.0",
      "upgrade_version": "1.17.0",
      "redundancy_zone": "a"
    },
    {
      "active_node": false,
      "api_address": "http://10.0.0.3:8200",
      "clock_skew_ms": 0,
      "cluster_address": "https://10.0.0.3:8201",
      "echo_duration_ms": 20,
      "hostname": "node2",
      "last_echo": "2024-03-04T08:05:48.403148-05:00",
      "replication_primary_canary_age_ms": 72,
      "version": "1.17.0",
      "upgrade_version": "1.17.0",
      "redundancy_zone": "a"
    },
    {
      "active_node": false,
      "api_address": "http://10.0.0.4:8200",
      "clock_skew_ms": -1,
      "cluster_address": "https://10.0.0.4:8201",
      "echo_duration_ms": 17,
      "hostname": "node3",
      "last_echo": "2024-03-04T08:05:48.657318-05:00",
      "replication_primary_canary_age_ms": 950,
      "version": "1.17.0",
      "upgrade_version": "1.17.0",
      "redundancy_zone": "a"
    }
  ]
}

Note that in the above sample response, upgrade_version, redundancy_zone, and replication_primary_canary_age_ms are Enterprise-only fields.