v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23457.4 KB

private

Returns API's health status

Returns health status of the API and checks on dependent services

get/health

Response

Successfully returns OK status with checks of dependent services

status'OK' | 'WARNING' | 'CRITICAL'

The status of the API

uptimestring

The uptime of API

start_timestring

The start date and time of API running

Example response

{
  "version": {
    "build_time": "2020-06-11T12:49:20+01:00",
    "git_commit": "7c2febbf2b818175112478d4ffbadbee1b654f63",
    "language": "go",
    "language_version": "go1.14.3",
    "version": "1.0.0"
  },
  "uptime": "34516",
  "start_time": "2020-06-11T11:49:21.520922Z",
  "checks": [
    {
      "message": "mongodb is OK",
      "last_checked": "2020-06-11T11:49:50.330089Z",
      "last_success": "2020-06-11T11:49:50.330089Z",
      "last_failure": "2019-09-22T11:48:51.0000001Z"
    }
  ]
}