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

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

response = requests.get(url)

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

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

url = URI("https://api.example.com/api/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
{
  "status": 200,
  "message": "healthy",
  "data": {
    "cpu_usage_percent": 0.06,
    "mem_usage_percent": 1.31,
    "uptime": "72h3m0.5s"
  }
}
{
  "status": 500,
  "message": "unhealthy",
  "error": {
    "code": "ERROR_GETTING_CPU_USAGE",
    "description": "detailed description of the error..."
  }
}

Response

Database is healthy.

​
status
integer
required

Status code of the response

​
message
string
required

Message giving basic information on the response

​
data
object

Important data to be given to the caller

​
error
object

An error that has occured