For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETGet status
        • GETGet the health of a single adapter
        • GETGet the health of a single application
        • GETGet the health of all the adapters
        • GETGet the health of all the applications
        • GETGet the health of the server
        • GETGet the health of the system
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceHealth

Get the health of a single application

GET
http://localhost:3000/health/applications/:name
GET
/health/applications/:name
$curl http://localhost:3000/health/applications/ \
>     -u "<username>:<password>"
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}
Returns the health of a single application in Itential Platform.
Was this page helpful?
Previous

Get the health of all the adapters

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

namestringRequiredformat: "^[^\/]+$"Defaults to
The name for the selected application.

Response

Contains the selected applications 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