Summary
Get the health of the system.
Description
Get the health of the system.
Route
GET /health/system
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 system health data. |
Copied to Clipboard
{
"arch": "x64",
"release": "0.1.0",
"uptime": 12539,
"freemem": 14377422848,
"totalmem": 34359738368,
"loadavg": [
1.74169921875,
3.0166015625,
3.0166015625
],
"cpus": [
{
"model": "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz",
"speed": 2300,
"times": {
"user": 604790,
"nice": 0,
"sys": 322560,
"idle": 6071010,
"irq": 0
}
},
{
"model": "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz",
"speed": 2300,
"times": {
"user": 604790,
"nice": 0,
"sys": 322560,
"idle": 6071010,
"irq": 0
}
},
{
"model": "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz",
"speed": 2300,
"times": {
"user": 604790,
"nice": 0,
"sys": 322560,
"idle": 6071010,
"irq": 0
}
}
]
}
Copied to Clipboard
{
"type": "object",
"title": "results",
"properties": {
"arch": {
"type": "string",
"examples": [
"x64"
]
},
"release": {
"$ref": "services-health-schema#/definitions/version"
},
"uptime": {
"type": "integer",
"examples": [
12539
]
},
"freemem": {
"type": "integer",
"examples": [
14377422848
]
},
"totalmem": {
"type": "integer",
"examples": [
34359738368
]
},
"loadavg": {
"type": "array",
"items": {
"type": "number",
"examples": [
3.0166015625,
1.74169921875
]
}
},
"cpus": {
"type": "array",
"items": {
"type": "object",
"required": [
"model",
"speed",
"times"
],
"properties": {
"model": {
"type": "string",
"examples": [
"Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz"
]
},
"speed": {
"type": "integer",
"examples": [
2300
]
},
"times": {
"type": "object",
"required": [
"user",
"nice",
"sys",
"idle",
"irq"
],
"properties": {
"user": {
"type": "integer",
"examples": [
604790
]
},
"nice": {
"type": "integer",
"examples": [
0
]
},
"sys": {
"type": "integer",
"examples": [
322560
]
},
"idle": {
"type": "integer",
"examples": [
6071010
]
},
"irq": {
"type": "integer",
"examples": [
0
]
}
}
}
}
}
}
}
}