Supercheck

Returns the health status of the API and its dependencies.

GET

/api/health

Response Body

Health status

application/json

response

status*string

Value in"ok""degraded""unhealthy"

timestamp*string

Formatdate-time

latencyMs*integer

checks*

build*

Example Request

curl -X GET 'https://demo.supercheck.dev/api/health'

Example Request

curl -X GET 'https://demo.supercheck.dev/api/health'

Example ResponseSchema

{
  "status": "ok",
  "timestamp": "2019-08-24T14:15:22Z",
  "latencyMs": 0,
  "checks": {
    "database": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "redis": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    },
    "s3": {
      "status": "ok",
      "latencyMs": 0,
      "error": "string"
    }
  },
  "build": {
    "revision": "string"
  }
}

{  "status": "ok",  "timestamp": "2019-08-24T14:15:22Z",  "latencyMs": 0,  "checks": {    "database": {      "status": "ok",      "latencyMs": 0,      "error": "string"    },    "redis": {      "status": "ok",      "latencyMs": 0,      "error": "string"    },    "s3": {      "status": "ok",      "latencyMs": 0,      "error": "string"    }  },  "build": {    "revision": "string"  }}

Health check

Response BodyCopy Anchor Link

Response Body