Sign in
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"
    }
  }
}

Changes

Changed in 1 of the 24 revisions of this API.2

  • db102ef341f42See the full diff
    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the optional property details to the response with the 200 status

      response-optional-property-added