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

import requests

url = "https://api.example.com/health"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/health")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<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 | null

Detailed error information, if applicable.

Show child attributes