/health

GET

API to query the app for current health status

Responses

200: OK

Example value
{
  "type": "object",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "last_checked": {
            "description": "The last health check date and time of the external service",
            "type": "string",
            "example": "2020-06-11T11:49:50.330089Z"
          },
          "last_failure": {
            "description": "The last failed health check date and time of the external service",
            "type": "string",
            "example": "2019-09-22T11:48:51.0000001Z"
          },
          "last_success": {
            "description": "The last successful health check date and time of the external service",
            "type": "string",
            "example": "2020-06-11T11:49:50.330089Z"
          },
          "message": {
            "description": "The message status of the external service",
            "type": "string",
            "example": "mongodb is OK"
          },
          "name": {
            "description": "The name of external service used by API",
            "type": "string",
            "enum": [
              "mongodb"
            ]
          },
          "status": {
            "description": "The status of the external service",
            "type": "string",
            "enum": [
              "OK",
              "WARNING",
              "CRITICAL"
            ]
          }
        }
      }
    },
    "start_time": {
      "description": "The start date and time of API running",
      "type": "string",
      "example": "2020-06-11T11:49:21.520922Z"
    },
    "status": {
      "description": "The status of the API",
      "type": "string",
      "enum": [
        "OK",
        "WARNING",
        "CRITICAL"
      ]
    },
    "uptime": {
      "description": "The uptime of API",
      "type": "string",
      "example": "34516"
    },
    "version": {
      "type": "object",
      "properties": {
        "build_time": {
          "description": "The build date and time of the API",
          "type": "string",
          "example": "2020-06-11T12:49:20+01:00"
        },
        "git_commit": {
          "description": "The git commit hash of the API",
          "type": "string",
          "example": "7c2febbf2b818175112478d4ffbadbee1b654f63"
        },
        "language": {
          "description": "The programming language used to implement API",
          "type": "string",
          "example": "go"
        },
        "language_version": {
          "description": "The version of the programming language used to implement API",
          "type": "string",
          "example": "go1.14.3"
        },
        "version": {
          "description": "The version of API",
          "type": "string",
          "example": "1.0.0"
        }
      }
    }
  }
}

500: Internal Server Error

Example value
null