Health check endpoint
curl --request GET \
--url http://pinpoint.devops.arabiaweather.com/api/healthimport requests
url = "http://pinpoint.devops.arabiaweather.com/api/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://pinpoint.devops.arabiaweather.com/api/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 => "http://pinpoint.devops.arabiaweather.com/api/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 := "http://pinpoint.devops.arabiaweather.com/api/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("http://pinpoint.devops.arabiaweather.com/api/health")
.asString();require 'uri'
require 'net/http'
url = URI("http://pinpoint.devops.arabiaweather.com/api/health")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"dependencies": {
"redis_cache_write": {
"ok": true,
"time_ms": 3
},
"hijri_data": {
"ok": true,
"time_ms": 4
},
"redis_overrides": {
"ok": true,
"time_ms": 0
},
"redis_cache_read": {
"ok": true,
"time_ms": 3
},
"modms": {
"ok": true,
"time_ms": 54
}
},
"status": "ok"
}admin
Health check endpoint
Returns the health status of the API server
GET
/
api
/
health
Health check endpoint
curl --request GET \
--url http://pinpoint.devops.arabiaweather.com/api/healthimport requests
url = "http://pinpoint.devops.arabiaweather.com/api/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://pinpoint.devops.arabiaweather.com/api/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 => "http://pinpoint.devops.arabiaweather.com/api/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 := "http://pinpoint.devops.arabiaweather.com/api/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("http://pinpoint.devops.arabiaweather.com/api/health")
.asString();require 'uri'
require 'net/http'
url = URI("http://pinpoint.devops.arabiaweather.com/api/health")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"dependencies": {
"redis_cache_write": {
"ok": true,
"time_ms": 3
},
"hijri_data": {
"ok": true,
"time_ms": 4
},
"redis_overrides": {
"ok": true,
"time_ms": 0
},
"redis_cache_read": {
"ok": true,
"time_ms": 3
},
"modms": {
"ok": true,
"time_ms": 54
}
},
"status": "ok"
}Response
200 - application/json
API is healthy
Overall health status
Example:
"ok"
Health status of various dependencies
Show child attributes
Show child attributes
Example:
{
"redis_cache_write": { "ok": true, "time_ms": 3 },
"hijri_data": { "ok": true, "time_ms": 4 },
"redis_overrides": { "ok": true, "time_ms": 0 },
"redis_cache_read": { "ok": true, "time_ms": 3 },
"modms": { "ok": true, "time_ms": 54 }
}
⌘I

