Get the health of the server

GET

https://example.itential.io/health/server

GET

/health/server

$ curl https://example.itential.io/health/server \
>      -u "<username>:<password>"

1 {
2   "version": "0.0.1",
3   "release": "0.0.1",
4   "arch": "arm",
5   "platform": "aix",
6   "versions": {
7     "node": "0.0.1",
8     "v8": "0.0.1",
9     "uv": "0.0.1",
10     "zlib": "0.0.1",
11     "brotli": "0.0.1",
12     "ares": "0.0.1",
13     "modules": "0.0.1",
14     "nghttp2": "0.0.1",
15     "napi": "0.0.1",
16     "llhttp": "0.0.1",
17     "http_parser": "0.0.1",
18     "openssl": "0.0.1",
19     "cldr": "0.0.1",
20     "icu": "0.0.1",
21     "tz": "0.0.1",
22     "unicode": "0.0.1"
23   },
24   "memoryUsage": {
25     "rss": 7125982,
26     "heapTotal": 7125982,
27     "heapUsed": 7125982,
28     "external": 7125982
29   },
30   "cpuUsage": {
31     "user": 7125982,
32     "system": 7125982
33   },
34   "uptime": 2245.9722,
35   "pid": 7125982,
36   "dependencies": {
37     "@itential/logger": "0.0.1",
38     "@itential/database": "0.0.1",
39     "@itential/itential-utils": "0.0.1"
40   }
41 }

Returns the health of the server.

Authentication

AuthorizationBasic

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

Response

Contains the server health data.

versionstringOptional

releasestringOptional

archenumOptional

platformenumOptional

versionsobjectOptional

memoryUsageobjectOptional

cpuUsageobjectOptional

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)

uptimedoubleOptional

Number of seconds the current process has been running.

pidintegerOptional

dependenciesobjectOptional

Errors

500

Internal Server Error