Skip to main content

/sys/health

The /sys/health endpoint is used to check the health status of OpenBao.

Read health information​

This endpoint returns the health status of OpenBao. This matches the semantics of a Consul HTTP health check and provides a simple way to monitor the health of a OpenBao instance.

MethodPath
HEAD/sys/health
GET/sys/health

The default status codes are:

  • 200 if initialized, unsealed, and active
  • 429 if unsealed and standby
  • 501 if not initialized
  • 503 if sealed

Parameters​

  • standbyok (bool: false) – Specifies if being a standby should still return the active status code instead of the standby status code. This is useful when OpenBao is behind a non-configurable load balancer that just wants a 200-level response.

  • activecode (int: 200) – Specifies the status code that should be returned for an active node.

  • standbycode (int: 429) – Specifies the status code that should be returned for a standby node.

  • sealedcode (int: 503) – Specifies the status code that should be returned for a sealed node.

  • uninitcode (int: 501) – Specifies the status code that should be returned for a uninitialized node.

Sample request​

$ curl \
    http://127.0.0.1:8200/v1/sys/health

Sample response​

This response is only returned for a GET request.

{
  "initialized": true,
  "sealed": false,
  "standby": false,
  "performance_standby": false,
  "replication_performance_mode": "disabled",
  "replication_dr_mode": "disabled",
  "server_time_utc": 1516639589,
  "version": "0.9.2",
  "cluster_name": "openbao-cluster-3bd69ca2",
  "cluster_id": "00af5aa8-c87d-b5fc-e82e-97cd8dfaf731"
}

Sample request to customize the status code being returned​

$ curl -i https://127.0.0.1:8200/v1/sys/health\?standbycode\=200

HTTP/2 200
cache-control: no-store
content-type: application/json
strict-transport-security: max-age=31536000; includeSubDomains
content-length: 364
date: Wed, 26 Jan 2022 09:21:13 GMT

Sample response​

This response is only returned for a GET request.

{
  "initialized": true,
  "sealed": false,
  "standby": false,
  "performance_standby": false,
  "replication_performance_mode": "disabled",
  "replication_dr_mode": "disabled",
  "server_time_utc": 1706217694,
  "version": "1.14.8",
  "cluster_name": "openbao-cluster-6fc973c2",
  "cluster_id": "8190fce1-679e-3a57-7d1f-f63d4851633b"
}