Get the health of the server

curl http://localhost:3000/health/server \
     -u "<username>:<password>"

{
  "version": "0.0.1",
  "release": "0.0.1",
  "arch": "arm",
  "platform": "aix",
  "versions": {
    "node": "0.0.1",
    "v8": "0.0.1",
    "uv": "0.0.1",
    "zlib": "0.0.1",
    "brotli": "0.0.1",
    "ares": "0.0.1",
    "modules": "0.0.1",
    "nghttp2": "0.0.1",
    "napi": "0.0.1",
    "llhttp": "0.0.1",
    "http_parser": "0.0.1",
    "openssl": "0.0.1",
    "cldr": "0.0.1",
    "icu": "0.0.1",
    "tz": "0.0.1",
    "unicode": "0.0.1"
  },
  "memoryUsage": {
    "rss": 7125982,
    "heapTotal": 7125982,
    "heapUsed": 7125982,
    "external": 7125982
  },
  "cpuUsage": {
    "user": 7125982,
    "system": 7125982
  },
  "uptime": 2245.9722,
  "pid": 7125982,
  "dependencies": {
    "@itential/logger": "0.0.1",
    "@itential/database": "0.0.1",
    "@itential/itential-utils": "0.0.1"
  }
}

Returns the health of the server.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Contains the server health data.

versionstring

releasestring

archenum

platformenum

versionsobject

memoryUsageobject

cpuUsageobject

Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)

uptimedouble

Number of seconds the current process has been running.

pidinteger

dependenciesobject

Errors

500

Internal Server Error