healthCheck #

Returns the status of Kuzzle and it's internal services.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_healthCheck[?services=<services>]
Method: GET

The route is case-sensitive. GET /_healthcheck (lowercase) is a different, lightweight probe endpoint: it does not run this action, always answers with a 200 status, does not check any service, and is not logged. See HTTP protocol.

Other protocols #

{
  "controller": "server",
  "action": "healthCheck",
  // optional
  "services" : "<services>"
}

Optional: #

services : You can specify which services you want the status of.(eg: "storageEngine,memoryStorage")

Response #

Returns the status of each services.

internalCache : used by Kuzzle to cache internal data, such as authentication tokens, documents followed by real-time subscriptions, active paginated search queries, API usage statistics or cluster state
memoryStorage : memory cache managed by Kuzzle's memoryStorage API
storageEngine: Underlying storage layer

The status can either be green, yellow or red.

{
  "status": 200,
  "error": null,
  "action": "healthCheck",
  "controller": "server",
  "collection": null,
  "index": null,
  "volatile": null,
  "requestId": "<unique request identifier>",
  "result": {
    "status": "<status>",
    "services": {
      "internalCache": "<status>",
      "memoryStorage": "<status>",
      "storageEngine": "<status>"
    }
  }
}