Health Check

Endpoint Summary

• Route: /health
• Method: GET
• Description: A simple endpoint to check the operational status of the service. It indicates if the application is running and able to respond to requests.
• Authentication: Not required (WithAuth: false).

Request Details

• Method: GET
• Path: /health
• Query Parameters: None
• Request Body: None

Response Details

• Success Response:
  • Code: 200 OK
  • Content-Type: application/json
  • Body:

    {
      "status": "OK"
    }

• Error Response:
  • Code: 500 Internal Server Error
  • Reason: This occurs only in the rare case that the server fails internally when creating the simple JSON response.
  • Body Example: "Internal Server Error" (Plain text)