70 lines
1.9 KiB
Markdown
70 lines
1.9 KiB
Markdown
---
|
|
layout: "http"
|
|
page_title: "HTTP API: /sys/health"
|
|
sidebar_current: "docs-http-debug-health"
|
|
description: |-
|
|
The '/sys/health' endpoint is used to check the health status of Vault.
|
|
---
|
|
|
|
# /sys/health
|
|
|
|
<dl>
|
|
<dt>Description</dt>
|
|
<dd>
|
|
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.
|
|
</dd>
|
|
|
|
<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 the active status code instead of the standby code
|
|
</li>
|
|
<li>
|
|
<span class="param">activecode</span>
|
|
<span class="param-flags">optional</span>
|
|
A query parameter provided to indicate the status code that should
|
|
be returned for an active node instead of the default of `200`
|
|
</li>
|
|
<li>
|
|
<span class="param">standbycode</span>
|
|
<span class="param-flags">optional</span>
|
|
A query parameter provided to indicate the status code that should
|
|
be returned for a standby node instead of the default of `429`
|
|
</li>
|
|
<li>
|
|
<span class="param">sealedcode</span>
|
|
<span class="param-flags">optional</span>
|
|
A query parameter provided to indicate the status code that should
|
|
be returned for a sealed node instead of the default of `500`
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
<dt>Returns</dt>
|
|
<dd>
|
|
|
|
```javascript
|
|
{
|
|
"initialized": true,
|
|
"sealed": false,
|
|
"standby": false
|
|
}
|
|
```
|
|
|
|
Default Status Codes:
|
|
|
|
* `200` if initialized, unsealed, and active.
|
|
* `429` if unsealed and standby.
|
|
* `500` if sealed, or if not initialized.
|
|
</dd>
|
|
</dl>
|