Health API

Reference documentation

The /health API endpoint

The /health API provides HTTP GET access to the health of a Sensu Enterprise installation.

/health (GET)

EXAMPLE

The following example demonstrates a request to the /health API, resulting in a JSON Hash indicating the health of Sensu Enterprise.

$ curl -s http://127.0.0.1:3000/health | jq .
{
  "sensu": {
    "sensu-1": {
      "output": "ok",
      "status": 0
    }
  },
  "uchiwa": "ok"
}

API Specification

/health (GET)
description Returns Sensu Enterprise health information. The returned status follows the Sensu status code specification.
example url http://hostname:3000/health
response type Hash
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)
output 
{
  "sensu": {
    "sensu-1": {
      "output": "ok",
      "status": 0
    }
  },
  "uchiwa": "ok"
}