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": "1.0.0",
"release": "1.1.1-2020.1.0",
"arch": "arm",
"platform": "darwin",
"versions": {
"node": "12.7.0",
"v8": "7.5.288.22-node.16",
"uv": "1.30.1",
"zlib": "1.2.11",
"brotli": "1.0.7",
"ares": "1.15.0",
"modules": "72",
"nghttp2": "1.39.1",
"napi": "4",
"llhttp": "1.1.4",
"http_parser": "2.8.0",
"openssl": "1.1.1c",
"cldr": "35.1",
"icu": "64.2",
"tz": "2019a",
"unicode": "12.1"
},
"memoryUsage": {
"rss": 122354016,
"heapTotal": 45002752,
"heapUsed": 39982056,
"external": 21542701
},
"cpuUsage": {
"user": 2773101,
"system": 1004280
},
"uptime": 30.595,
"pid": 2136
}
Copied to Clipboard
{
"title": "results",
"type": "object",
"properties": {
"version": {
"$ref": "services-health-schema#/properties/version"
},
"release": {
"$ref": "services-health-schema#/properties/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": {
"type": "string",
"examples": [
"12.7.0"
]
},
"v8": {
"type": "string",
"examples": [
"7.5.288.22-node.16"
]
},
"uv": {
"type": "string",
"examples": [
"1.30.1"
]
},
"zlib": {
"type": "string",
"examples": [
"1.2.11"
]
},
"brotli": {
"type": "string",
"examples": [
"1.0.7"
]
},
"ares": {
"type": "string",
"examples": [
"1.15.0"
]
},
"modules": {
"type": "string",
"examples": [
"72"
]
},
"nghttp2": {
"type": "string",
"examples": [
"1.39.1"
]
},
"napi": {
"type": "string",
"examples": [
"4"
]
},
"llhttp": {
"type": "string",
"examples": [
"1.1.4"
]
},
"http_parser": {
"type": "string",
"examples": [
"2.8.0"
]
},
"openssl": {
"type": "string",
"examples": [
"1.1.1c"
]
},
"cldr": {
"type": "string",
"examples": [
"35.1"
]
},
"icu": {
"type": "string",
"examples": [
"64.2"
]
},
"tz": {
"type": "string",
"examples": [
"2019a"
]
},
"unicode": {
"type": "string",
"examples": [
"12.1"
]
}
}
},
"memoryUsage": {
"type": "object",
"properties": {
"rss": {
"type": "integer",
"examples": [
122354016
]
},
"heapTotal": {
"type": "integer",
"examples": [
45002752
]
},
"heapUsed": {
"type": "integer",
"examples": [
39982056
]
},
"external": {
"type": "integer",
"examples": [
21542701
]
}
}
},
"cpuUsage": {
"type": "object",
"properties": {
"user": {
"type": "integer",
"examples": [
2773101
]
},
"system": {
"type": "integer",
"examples": [
1004280
]
}
}
},
"uptime": {
"type": "number",
"examples": [
"30.595"
]
},
"pid": {
"type": "integer",
"examples": [
"2136"
]
}
}
}