Skip to main content
GET
/
v1
/
health
Health Check
curl --request GET \
  --url https://api.example.com/v1/health
import requests

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

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/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/v1/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/v1/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/v1/health")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/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
Check if the API service is running and accessible.

Parameters

None

Authentication

Not required

Response

{
  "status": "healthy",
  "api_version": "v1",
  "version": "0.15.0"
}

Response Fields

FieldTypeDescription
statusstringHealth status of the service (always "healthy" if responding)
api_versionstringCurrent API version
versionstringApplication version number

Example Usage

curl http://localhost:8000/v1/health

# Or with HTTPS
curl https://your-domain.com:8000/v1/health

Use Cases

  • Health monitoring: Check if the service is operational
  • Load balancer checks: Verify service availability
  • Deployment validation: Confirm successful service startup
  • Network connectivity: Test basic API accessibility