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 the system

GET
http://localhost:3000/health/system
GET
/health/system
$curl http://localhost:3000/health/system \
>     -u "<username>:<password>"
1{
2  "arch": "x64",
3  "release": "0.0.1",
4  "uptime": 12539,
5  "freemem": 14377422848,
6  "totalmem": 34359738368,
7  "loadavg": [
8    3.02
9  ],
10  "cpus": [
11    {
12      "model": "Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz",
13      "speed": 2300,
14      "times": {
15        "user": 604790,
16        "nice": 0,
17        "sys": 322560,
18        "idle": 6071010,
19        "irq": 0
20      }
21    }
22  ]
23}
Returns the health of the system.
Was this page helpful?
Previous

Generate documentation for adapters

Next
Built with

Authentication

AuthorizationBasic

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

Response

Contains the system health data.
archstring
releasestring
uptimeinteger
freememinteger
totalmeminteger
loadavglist of doubles
cpuslist of objects

Errors

500
Internal Server Error