> ## Documentation Index
> Fetch the complete documentation index at: https://docs.engagefabric.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get system status

> Returns comprehensive system status including API, database, Redis, event queue, and WebSocket connections



## OpenAPI

````yaml /api-reference/openapi.json get /health/status
openapi: 3.0.0
info:
  title: EngageFabric API
  description: >-
    EngageFabric is a multi-tenant SaaS gamification framework. This API
    provides endpoints for managing players, tracking events, quests,
    adventures, leaderboards, lobbies, and real-time features.
  version: 1.0.0
  contact:
    name: EngageFabric Support
    url: https://engagefabric.com
    email: support@engagefabric.com
  license:
    name: Proprietary
    url: https://engagefabric.com/terms
servers:
  - url: https://api.engagefabric.com
    description: Production
  - url: http://localhost:3000
    description: Development
security: []
tags:
  - name: auth
    description: Authentication endpoints
  - name: tenants
    description: Tenant management
  - name: projects
    description: Project management
  - name: players
    description: Player management and game state
  - name: events
    description: Event ingestion and tracking
  - name: quests
    description: Quest management and progress
  - name: adventures
    description: Adventure/season management
  - name: leaderboards
    description: Leaderboard rankings
  - name: lobbies
    description: Multiplayer lobby management
  - name: chat
    description: Real-time chat
  - name: rules
    description: Rules engine configuration
paths:
  /health/status:
    get:
      tags:
        - health
      summary: Get system status
      description: >-
        Returns comprehensive system status including API, database, Redis,
        event queue, and WebSocket connections
      operationId: HealthController_getSystemStatus
      parameters: []
      responses:
        '200':
          description: System status retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  api:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - degraded
                          - unhealthy
                      uptime:
                        type: number
                        description: Uptime in seconds
                      version:
                        type: string
                  database:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - connected
                          - disconnected
                          - error
                      latencyMs:
                        type: number
                  redis:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - active
                          - disconnected
                          - error
                      latencyMs:
                        type: number
                  eventQueue:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - processing
                          - idle
                          - backlogged
                          - error
                      pendingEvents:
                        type: number
                  websocket:
                    type: object
                    properties:
                      connections:
                        type: number
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                  timestamp:
                    format: date-time
                    type: string

````