Get the health of a single adapter

Returns the health of a single adapter in Itential Platform.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

namestringRequiredformat: "^[^\/]+$"Defaults to

The name for the selected adapter.

Response

Contains the selected adapters health data.

idstring

package_idstringformat: "^@[-_.a-z]+/.+"Defaults to

The model used by the service

versionstring

typeenum

Allowed values:

descriptionstring

stateenum

Allowed values:

connectionany or object

uptimedouble

Number of seconds the current process has been running.

memoryUsageobject

cpuUsageobject

Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)

pidinteger

loggerobject

routePrefixstring

prevUptimedouble

Errors

500

Internal Server Error

1	{
2	"id": "AdminEssentials",
3	"package_id": "@itential/adapter-local_aaa",
4	"version": "0.0.1",
5	"type": "Adapter",
6	"description": "A basic description",
7	"state": "DEAD",
8	"connection": {},
9	"uptime": 2245.9722,
10	"memoryUsage": {
11	"rss": 7125982,
12	"heapTotal": 7125982,
13	"heapUsed": 7125982,
14	"external": 7125982
15	},
16	"cpuUsage": {
17	"user": 7125982,
18	"system": 7125982
19	},
20	"pid": 7125982,
21	"logger": {
22	"console": "error",
23	"file": "error",
24	"syslog": "debug"
25	},
26	"routePrefix": "admin",
27	"prevUptime": 2245.9722
28	}

1	curl http://localhost:3000/health/adapters/ \
2	-u "<username>:<password>"