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 status

GET
http://localhost:3000/health/status
GET
/health/status
$curl http://localhost:3000/health/status
1{
2  "host": "string",
3  "serverId": "string",
4  "services": [
5    {
6      "service": "string",
7      "status": "running"
8    }
9  ],
10  "timestamp": 1,
11  "apps": "running",
12  "adapters": "running"
13}
Returns status of current Itential Platform.
Was this page helpful?
Previous

Get the health of a single adapter

Next
Built with

Query parameters

exclude-servicesbooleanOptional
When set to true, this method will skip its liveness check against downstream services

Response

status of the current IAP.
hoststring
serverIdstring
serviceslist of objects
timestampinteger
appsenum
Allowed values:
adaptersenum
Allowed values:

Errors

500
Internal Server Error