Health Check

API endpoint to verify service availability and database connection

GET /health

Health Check

cURL

curl --request GET \
  --url https://api.example.com/health

200

{
  "success": true,
  "message": "<string>",
  "data": "<unknown>",
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

Example Usage

For complete API documentation and examples, please refer to your Swagger UI.

curl -X 'GET' \
  'https://localhost:8080/health' \
  -H 'accept: application/json'

Query Parameters

mongo_db_check · integer | null · default: 1

Response

200

application/json

Successful Response

success · boolean · required

Indicates whether the request was successful.

message · string | null

A brief message about the response.

data · any | null

The payload of the response.

error · ErrorResponse · object

Detailed error information, if applicable.

Show child attributes