mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-02 11:38:02 +00:00
cf43d3eeed
* Add administrative namespace section to namespaces docs * Tag sys endpoints with restricted admin alert --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
69 lines
1.7 KiB
Plaintext
69 lines
1.7 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/ha-status - HTTP API
|
|
description: The `/sys/ha-status` endpoint is used to check the HA status of a Vault cluster.
|
|
---
|
|
|
|
# `/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
|
|
|
|
@include 'alerts/restricted-admin.mdx'
|
|
|
|
This endpoint returns the HA status of the Vault cluster.
|
|
|
|
| Method | Path |
|
|
| :----- | :----------------- |
|
|
| `GET` | `/sys/ha-status` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
http://127.0.0.1:8200/v1/sys/ha-status
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json
|
|
{
|
|
"Nodes": [
|
|
{
|
|
"hostname": "node1",
|
|
"api_address": "http://10.0.0.2:8200",
|
|
"cluster_address": "https://10.0.0.2:8201",
|
|
"active_node": true,
|
|
"last_echo": null,
|
|
"version": "1.11.0",
|
|
"upgrade_version": "1.11.0",
|
|
"redundancy_zone": "a"
|
|
},
|
|
{
|
|
"hostname": "node2",
|
|
"api_address": "http://10.0.0.3:8200",
|
|
"cluster_address": "https://10.0.0.3:8201",
|
|
"active_node": false,
|
|
"last_echo": "2021-11-29T10:29:09.202235-05:00",
|
|
"version": "1.11.0",
|
|
"upgrade_version": "1.11.0",
|
|
"redundancy_zone": "a"
|
|
},
|
|
{
|
|
"hostname": "node3",
|
|
"api_address": "http://10.0.0.4:8200",
|
|
"cluster_address": "https://10.0.0.4:8201",
|
|
"active_node": false,
|
|
"last_echo": "2021-11-29T10:29:07.402548-05:00",
|
|
"version": "1.11.0",
|
|
"upgrade_version": "1.11.0",
|
|
"redundancy_zone": "a"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
Note that in the above sample response, `upgrade_version` and `redundancy_zone` are Enterprise-only fields.
|