Health

This endpoint provides the health status of the service, including the number of active sessions and the current version.


Endpoint

GET /health


Response

Response Parameters

  • status (required):

    • Type: string

    • Description: The health status of the service. The value is healthy when the service is operational.

  • active_sessions (required):

    • Type: integer

    • Description: The number of active sessions currently managed by the service.

  • version (required):

    • Type: string

    • Description: The current version of the service.


Example Response

200 - application/json

{
    "status": "healthy",
    "active_sessions": 42,
    "version": "1.2.3"
}

Last updated