Skip to main content
GET
Sessions API health check
This endpoint provides real-time health metrics for the Sessions API service, including active session counts and service uptime.

Response

string
Service health status: “healthy”, “degraded”, or “unhealthy”
number
Number of currently active (non-expired) sessions
string
ISO timestamp of the health check
number
Number of sessions that are within their warning threshold
number
Number of corrupted or invalid sessions detected (only shown if > 0)
number
Service uptime in seconds

Example Response

Health Status Meanings

  • healthy: Service is operating normally
  • degraded: Service is operational but experiencing issues (e.g., invalid sessions detected)
  • unhealthy: Service is not operational or experiencing critical issues

Usage

This endpoint is useful for:
  • Monitoring service availability
  • Tracking session volume
  • Detecting memory leaks (via active session count)
  • Setting up health check probes in orchestration systems
  • Dashboard metrics and alerting

Response

200 - application/json

Sessions API is healthy

status
enum<string>
Available options:
healthy,
degraded,
unhealthy
activeSessions
integer

Number of currently active sessions

timestamp
string<date-time>
expiringSoon
integer

Number of sessions near expiration

invalidSessions
integer

Number of invalid sessions detected (only shown if > 0)

uptime
number

Service uptime in seconds