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
    • 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 all the adapters

GET
http://localhost:3000/health/adapters
GET
/health/adapters
$curl http://localhost:3000/health/adapters \
>     -u "<username>:<password>"
1{
2  "results": [
3    {
4      "id": "AdminEssentials",
5      "package_id": "@itential/adapter-local_aaa",
6      "version": "0.0.1",
7      "type": "Adapter",
8      "description": "A basic description",
9      "state": "DEAD",
10      "connection": {},
11      "uptime": 2245.9722,
12      "memoryUsage": {
13        "rss": 7125982,
14        "heapTotal": 7125982,
15        "heapUsed": 7125982,
16        "external": 7125982
17      },
18      "cpuUsage": {
19        "user": 7125982,
20        "system": 7125982
21      },
22      "pid": 7125982,
23      "logger": {
24        "console": "error",
25        "file": "error",
26        "syslog": "debug"
27      },
28      "routePrefix": "admin",
29      "prevUptime": 2245.9722
30    }
31  ],
32  "total": 1
33}
Returns the health of all the adapters in Itential Platform.
Was this page helpful?
Previous

Get the health of all the applications

Next
Built with

Authentication

AuthorizationBasic

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

Query parameters

containsstringOptional
contains
containsFieldstringOptional
containsField
equalsstringOptional
equals
equalsFieldstringOptional
equalsField
startsWithstringOptional
startsWith
startsWithFieldstringOptional
startsWithField
skipintegerOptional>=0Defaults to 0
skip
limitintegerOptional>=0Defaults to 25
limit
sortenumOptionalDefaults to name
sort
Allowed values:
orderenumOptionalDefaults to 1
order
Allowed values:

Response

Contains the adapters health data.
resultslist of objects
totalinteger>=0
The total number of documents

Errors

500
Internal Server Error