Health Check
curl --request GET \
--url https://api.example.com/v1/healthimport 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{
"status": "<string>",
"timestamp": "<string>",
"checks": {}
}Account
Health Check
Check API and service status.
GET
/
v1
/
health
Health Check
curl --request GET \
--url https://api.example.com/v1/healthimport 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{
"status": "<string>",
"timestamp": "<string>",
"checks": {}
}Check the health of the API and its dependencies. No authentication required.
Response
string
required
Overall status:
ok or degraded.string
required
Current server time (ISO 8601).
object
required
Status of individual services.
Example
curl https://api.stashfyle.com/v1/health
const response = await fetch('https://api.stashfyle.com/v1/health');
const health = await response.json();
if (health.status !== 'ok') {
console.warn('API degraded:', health.checks);
}
Response
{
"status": "ok",
"timestamp": "2024-01-15T10:30:00Z",
"checks": {
"database": { "status": "ok", "latency_ms": 12 },
"storage": { "status": "ok", "latency_ms": 45 }
}
}
Use Cases
- Uptime monitoring (Pingdom, UptimeRobot, etc.)
- Load balancer health checks
- CI/CD deployment verification
⌘I