open-vault/website/source/docs/http/sys-health.html.md

750 B

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.
<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.