2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/health - HTTP API
|
|
|
|
|
sidebar_title: <code>/sys/health</code>
|
|
|
|
|
description: The `/sys/health` endpoint is used to check the health status of Vault.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/health`
|
|
|
|
|
|
|
|
|
|
The `/sys/health` endpoint is used to check the health status of Vault.
|
|
|
|
|
|
|
|
|
|
## Read Health Information
|
|
|
|
|
|
|
|
|
|
This endpoint returns the health status of Vault. This matches the semantics of
|
|
|
|
|
a Consul HTTP health check and provides a simple way to monitor the health of a
|
|
|
|
|
Vault instance.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :------------ |
|
|
|
|
|
| `HEAD` | `/sys/health` |
|
|
|
|
|
| `GET` | `/sys/health` |
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
The default status codes are:
|
|
|
|
|
|
|
|
|
|
- `200` if initialized, unsealed, and active
|
|
|
|
|
- `429` if unsealed and standby
|
2019-11-06 22:16:39 +00:00
|
|
|
|
- `472` if disaster recovery mode replication secondary and active
|
|
|
|
|
- `473` if performance standby
|
2017-03-15 06:40:33 +00:00
|
|
|
|
- `501` if not initialized
|
|
|
|
|
- `503` if sealed
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `standbyok` `(bool: false)` – Specifies if being a standby should still return
|
|
|
|
|
the active status code instead of the standby status code. This is useful when
|
2019-08-05 20:44:41 +00:00
|
|
|
|
Vault is behind a non-configurable load balancer that just wants a 200-level
|
2018-11-29 17:57:30 +00:00
|
|
|
|
response. This will not apply if the node is a performance standby.
|
2019-11-06 22:16:39 +00:00
|
|
|
|
|
2018-11-29 17:57:30 +00:00
|
|
|
|
- `perfstandbyok` `(bool: false)` – Specifies if being a performance standby should
|
|
|
|
|
still return the active status code instead of the performance standby status code.
|
2019-08-05 20:44:41 +00:00
|
|
|
|
This is useful when Vault is behind a non-configurable load balancer that just wants
|
2018-11-29 17:57:30 +00:00
|
|
|
|
a 200-level response.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
- `activecode` `(int: 200)` – Specifies the status code that should be returned
|
|
|
|
|
for an active node.
|
|
|
|
|
|
|
|
|
|
- `standbycode` `(int: 429)` – Specifies the status code that should be returned
|
|
|
|
|
for a standby node.
|
|
|
|
|
|
2018-05-18 16:39:13 +00:00
|
|
|
|
- `drsecondarycode` `(int: 472)` – Specifies the status code that should be
|
|
|
|
|
returned for a DR secondary node.
|
|
|
|
|
|
2018-08-28 19:48:02 +00:00
|
|
|
|
- `performancestandbycode` `(int: 473)` – Specifies the status code that should be
|
|
|
|
|
returned for a performance standby node.
|
|
|
|
|
|
2017-03-15 06:40:33 +00:00
|
|
|
|
- `sealedcode` `(int: 503)` – Specifies the status code that should be returned
|
|
|
|
|
for a sealed node.
|
|
|
|
|
|
|
|
|
|
- `uninitcode` `(int: 501)` – Specifies the status code that should be returned
|
|
|
|
|
for a uninitialized node.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-03-15 06:40:33 +00:00
|
|
|
|
$ curl \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/health
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
This response is only returned for a `GET` request.
|
|
|
|
|
|
2018-01-23 02:44:38 +00:00
|
|
|
|
Note: `replication_perf_mode` and `replication_dr_mode` reflect the state of
|
|
|
|
|
the active node in the cluster; if you are querying it for a standby that has
|
|
|
|
|
just come up, it can take a small time for the active node to inform the
|
|
|
|
|
standby of its status.
|
2018-02-22 15:52:04 +00:00
|
|
|
|
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```json
|
|
|
|
|
{
|
2018-01-23 02:44:38 +00:00
|
|
|
|
"initialized": true,
|
2017-03-15 06:40:33 +00:00
|
|
|
|
"sealed": false,
|
2018-01-23 02:44:38 +00:00
|
|
|
|
"standby": false,
|
2018-08-28 19:48:02 +00:00
|
|
|
|
"performance_standby": false,
|
2018-01-23 02:44:38 +00:00
|
|
|
|
"replication_perf_mode": "disabled",
|
|
|
|
|
"replication_dr_mode": "disabled",
|
|
|
|
|
"server_time_utc": 1516639589,
|
|
|
|
|
"version": "0.9.1",
|
|
|
|
|
"cluster_name": "vault-cluster-3bd69ca2",
|
|
|
|
|
"cluster_id": "00af5aa8-c87d-b5fc-e82e-97cd8dfaf731"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|