---
title: "GET /health/websocket"
method: GET
path: "/health/websocket"
tags: ["health"]
---

# GET /health/websocket

`GET /health/websocket`

## Request

- Base URL: `http://localhost:3000`
- URL: `http://localhost:3000/health/websocket`
- Auth: none declared

Get WebSocket server health and connection metrics

## Response `200`

Default Response

- object
  - `success` boolean
  - `data` object
    - `status` 'healthy' | 'degraded' | 'unhealthy': Overall WebSocket server health status
    - `initialized` boolean: Whether WebSocket server is initialized
    - `connections` object
      - `total` number: Total number of socket connections
      - `users` number: Number of unique users connected
      - `bot` boolean: Whether Discord bot is connected
    - `timestamp` number
  - `meta` object
    - `timestamp` number

## Other responses

- `500`: Default Response

---

[API](https://skmtc.dev/farmersonly/apis/farmersonly-club-api.md) - [All operations](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/llms.txt) - [OpenAPI document](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/revisions/b4fa9123ba90?raw)
