Summary
Get the health of all services.
Description
Gets the health of all services in an IAP environment.
Route
GET /admin/services/health
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 services health data. |
Copied to Clipboard
{
"results": [
{
"id": "AdminEssentials",
"package_id": "@itential/adapter-local_aaa",
"version": "1.1.1-2020.1.0",
"type": "Adapter",
"description": "Description about the functionality of an artifact",
"state": "STOPPED",
"connection": {
"state": "aliqua"
},
"uptime": 2245.9722,
"memoryUsage": {
"rss": 7125982,
"heapTotal": 7125982,
"heapUsed": 7125982,
"external": 7125982
},
"cpuUsage": {
"user": 7125982,
"system": 7125982
},
"pid": 7125982,
"logger": {
"console": "error",
"file": "error"
},
"routePrefix": "search",
"prevUptime": 2245.9722
}
],
"total": -34132990
}
Copied to Clipboard
{
"title": "results",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"AdminEssentials"
]
},
"package_id": {
"type": "string",
"title": "Model",
"default": "",
"description": "The model used by the service",
"examples": [
"@itential/adapter-local_aaa"
],
"pattern": "^@[a-z]+/.+"
},
"version": {
"type": "string",
"examples": [
"0.0.1",
"0.1.0",
"1.0.0",
"1.1.1-2020.1.0"
]
},
"type": {
"type": "string",
"enum": [
"Adapter",
"Application"
]
},
"description": {
"type": "string",
"examples": [
"Description about the functionality of an artifact"
]
},
"state": {
"type": "string",
"enum": [
"DEAD",
"STOPPED",
"RUNNING",
"DELETED"
]
},
"connection": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"properties": {
"state": {
"type": "string"
}
}
}
]
},
"uptime": {
"type": "number",
"examples": [
"2245.9722"
]
},
"memoryUsage": {
"type": "object",
"properties": {
"rss": {
"type": "integer",
"examples": [
"7125982"
]
},
"heapTotal": {
"type": "integer",
"examples": [
"7125982"
]
},
"heapUsed": {
"type": "integer",
"examples": [
"7125982"
]
},
"external": {
"type": "integer",
"examples": [
"7125982"
]
}
}
},
"cpuUsage": {
"type": "object",
"properties": {
"user": {
"type": "integer",
"examples": [
"7125982"
]
},
"system": {
"type": "integer",
"examples": [
"7125982"
]
}
}
},
"pid": {
"type": "integer",
"examples": [
"7125982"
]
},
"logger": {
"type": "object",
"properties": {
"console": {
"type": "string",
"enum": [
"error",
"warn",
"info",
"debug",
"trace",
"spam"
]
},
"file": {
"type": "string",
"enum": [
"error",
"warn",
"info",
"debug",
"trace",
"spam"
]
},
"syslog": {
"oneOf": [
{
"type": "object",
"maxProperties": 0
},
{
"type": "string",
"enum": [
"debug",
"info",
"warning",
"warn",
"error"
]
}
]
}
}
},
"routePrefix": {
"type": "string",
"examples": [
"admin",
"search"
]
},
"prevUptime": {
"type": "number",
"examples": [
"2245.9722"
]
}
}
}
},
"total": {
"$id": "#/properties/total",
"type": "integer"
}
}
}