44 lines
750 B
Markdown
44 lines
750 B
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>
|
||
|
|
None
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt>Returns</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
```
|
||
|
|
{
|
||
|
|
"initialized": true,
|
||
|
|
"sealed": false,
|
||
|
|
"standby": false
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Status Codes:
|
||
|
|
|
||
|
|
* `200` if initialized, unsealed and active.
|
||
|
|
* `429` if unsealed and standby.
|
||
|
|
* `500` if not initialized or sealed.
|
||
|
|
</dd>
|
||
|
|
</dl>
|