nomad/website/source/docs/http/sys-health.html.md

layout, page_title, sidebar_current, description

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

/sys/health

Description

Returns the health status of Nomad. This matches the semantics of a Consul HTTP health check and provides a simple way to monitor the health of a Nomad instance.

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

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