Skip to content

Get System Health Direct

GET
/api/system/health

System health check endpoint.

Successful Response

HealthCheckDetailedResponse

Detailed health check response for /health endpoint.

Provides comprehensive system health information including overall status, component health, and system resources.

object
status
required
Status

Overall system status

string
message
Message

Status message

string
""
data

Additional health data

object
key
additional properties
any
timestamp
Timestamp

Health check timestamp

string format: date-time
components
Components

Component health details

object
key
additional properties
ComponentHealth

Component health information for system health checks

object
status
required
Status

Component status (active, degraded, offline)

string
responseTimeMs
required
Responsetimems

Component response time in milliseconds

number
lastCheck
required
Lastcheck

Last health check timestamp

string format: date-time
errorMessage
Any of:
string