50f720bc06
This also standardizes on the indentation we use for multi-line commands as well as prefixes all commands with a $ to indicate a shell.
1.1 KiB
1.1 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| http | HTTP API: /sys/health | docs-http-debug-health | The '/sys/health' endpoint is used to check the health status of Vault. |
/sys/health
- Description
- 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.
200if initialized, unsealed and active.429if unsealed and standby.500if not initialized or sealed.
<dt>Method</dt>
<dd>GET</dd>
<dt>Parameters</dt>
<dd>
<ul>
<li>
<span class="param">standbyok</span>
<span class="param-flags">optional</span>
A query parameter provided to indicate that being a standby should
still return a 200 status code instead of the standard 429 status code.
</li>
</ul>
</dd>
<dt>Returns</dt>
<dd>
```javascript
{
"initialized": true,
"sealed": false,
"standby": false
}
```
Status Codes: