Skip to main content
GET
Get system health information

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

includeHistory
boolean

Include historical health data

Response

Returns system health information

status
enum<string>
required
Available options:
healthy,
unhealthy
Example:

"healthy"

lastChecked
string<date-time>
required
Example:

"2025-01-01T00:00:00.000Z"

cpuUsage
number
required
Example:

45.2

memoryUsage
number
required
Example:

62.7

totalMemoryMB
number
required
Example:

8192

usedMemoryMB
number
required
Example:

5120

diskUsage
number
required
Example:

78.3

totalDiskMB
number
required
Example:

500000

usedDiskMB
number
required
Example:

391500

systemUptime
string
required
Example:

"5d 12h 30m"

nodeHeapUsedMB
number
required
Example:

512

nodeHeapTotalMB
number
required
Example:

1024

eventLoopLagMs
number
required
Example:

5.2

databaseConnected
boolean
required
Example:

true

dbConnections
number
required
Example:

25

maxDbConnections
number
required
Example:

100

dbConnectionUsage
number
required
Example:

45.8

avgQueryTimeMs
number
required
Example:

12.3

slowQueriesCount
number
required
Example:

5

dbSizeMB
number
required
Example:

1024

servicesRunning
boolean
required
Example:

true

apiRequestRate
number
required
Example:

250

maxApiRequestRate
number
required
Example:

500

avgResponseTimeMs
number
required
Example:

85.2

errorRate
number
required
Example:

0.5

activeUserSessions
number
required
Example:

120

cacheHitRatio
number
required
Example:

95.7

serviceDependencies
object
required
Example:
error
string

Error message if status is unhealthy

Example:

"Database connection failed"

Example: