v24

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2023-10-2712636.3 KB
healthcheck

Performs a healthcheck

This will return 200 and a JSON object with relevant status information when the service is running and healthy.

get/healthcheck

Response

An object detailing the status of the service and the involved components.

statusstring

Example response

{
  "status": "pass",
  "details": {
    "MongoDB": {
      "status": "pass"
    },
    "queue": {
      "status": "pass"
    }
  }
}