Summary
Get the health of the server.
Description
Get the health of the server.
Route
GET /health/server
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
This method has no parameters |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
results |
object |
Contains the server health data. |
Copied to Clipboard
{
"version": "0.1.0",
"release": "1.1.1-2020.1.0",
"arch": "ia32",
"platform": "openbsd",
"versions": {
"node": "0.1.0",
"v8": "1.0.0",
"uv": "0.0.1",
"zlib": "1.0.0",
"brotli": "1.0.0",
"ares": "1.1.1-2020.1.0",
"modules": "0.0.1",
"nghttp2": "0.0.1",
"napi": "1.1.1-2020.1.0",
"llhttp": "0.0.1",
"http_parser": "1.1.1-2020.1.0",
"openssl": "0.0.1",
"cldr": "1.1.1-2020.1.0",
"icu": "0.1.0",
"tz": "0.0.1",
"unicode": "0.1.0"
},
"memoryUsage": {
"rss": 7125982,
"heapTotal": 7125982,
"heapUsed": 7125982,
"external": 7125982
},
"cpuUsage": {
"user": 7125982,
"system": 7125982
},
"uptime": 2245.9722,
"pid": 7125982,
"dependencies": {
"@itential/audit-trail": "1.0.0",
"@itential/event-system": "1.1.1-2020.1.0",
"@itential/network": "1.1.1-2020.1.0",
"@itential/service": "0.0.1",
"@itential/logger": "0.0.1",
"@itential/database": "1.0.0",
"@itential/itential-utils": "1.0.0"
}
}
Copied to Clipboard
{
"title": "results",
"type": "object",
"properties": {
"version": {
"$ref": "services-health-schema#/definitions/version"
},
"release": {
"$ref": "services-health-schema#/definitions/version"
},
"arch": {
"type": "string",
"enum": [
"arm",
"arm64",
"ia32",
"mips",
"mipsel",
"ppc",
"ppc64",
"s390",
"s390x",
"x32",
"x64"
]
},
"platform": {
"type": "string",
"enum": [
"aix",
"darwin",
"freebsd",
"linux",
"openbsd",
"sunos",
"win32"
]
},
"versions": {
"type": "object",
"properties": {
"node": {
"$ref": "services-health-schema#/definitions/version"
},
"v8": {
"$ref": "services-health-schema#/definitions/version"
},
"uv": {
"$ref": "services-health-schema#/definitions/version"
},
"zlib": {
"$ref": "services-health-schema#/definitions/version"
},
"brotli": {
"$ref": "services-health-schema#/definitions/version"
},
"ares": {
"$ref": "services-health-schema#/definitions/version"
},
"modules": {
"$ref": "services-health-schema#/definitions/version"
},
"nghttp2": {
"$ref": "services-health-schema#/definitions/version"
},
"napi": {
"$ref": "services-health-schema#/definitions/version"
},
"llhttp": {
"$ref": "services-health-schema#/definitions/version"
},
"http_parser": {
"$ref": "services-health-schema#/definitions/version"
},
"openssl": {
"$ref": "services-health-schema#/definitions/version"
},
"cldr": {
"$ref": "services-health-schema#/definitions/version"
},
"icu": {
"$ref": "services-health-schema#/definitions/version"
},
"tz": {
"$ref": "services-health-schema#/definitions/version"
},
"unicode": {
"$ref": "services-health-schema#/definitions/version"
}
}
},
"memoryUsage": {
"$ref": "services-health-schema#/definitions/memoryUsage"
},
"cpuUsage": {
"$ref": "services-health-schema#/definitions/cpuUsage"
},
"uptime": {
"$ref": "services-health-schema#/definitions/uptime"
},
"pid": {
"$ref": "services-health-schema#/definitions/pid"
},
"dependencies": {
"type": "object",
"properties": {
"@itential/audit-trail": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/event-system": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/network": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/service": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/logger": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/database": {
"$ref": "services-health-schema#/definitions/version"
},
"@itential/itential-utils": {
"$ref": "services-health-schema#/definitions/version"
}
}
}
}
}