Summary
Get the health of all the applications.
Description
Get the health of all the applications in IAP.
Route
GET /health/applications
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "redis",
"containsField": "name",
"equals": "redis",
"equalsField": "name",
"startsWith": "redis",
"startsWithField": "name",
"skip": 50,
"limit": 1,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"redis"
]
},
"containsField": {
"type": "string",
"examples": [
"name"
]
},
"equals": {
"type": "string",
"examples": [
"redis"
]
},
"equalsField": {
"type": "string",
"examples": [
"name"
]
},
"startsWith": {
"type": "string",
"examples": [
"redis"
]
},
"startsWithField": {
"type": "string",
"examples": [
"name"
]
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
Contains the applications health data. |
Copied to Clipboard
{
"results": [
{
"id": "AdminEssentials",
"package_id": "@itential/adapter-local_aaa",
"version": "0.0.1",
"type": "Application",
"description": "A basic description",
"state": "RUNNING",
"connection": {
"state": "ONLINE"
},
"uptime": 2245.9722,
"memoryUsage": {
"rss": 7125982,
"heapTotal": 7125982,
"heapUsed": 7125982,
"external": 7125982
},
"cpuUsage": {
"user": 7125982,
"system": 7125982
},
"pid": 7125982,
"logger": {
"console": "spam",
"file": "error",
"syslog": "warning"
},
"routePrefix": "admin",
"prevUptime": 2245.9722
}
],
"total": 10
}
