Health check
curl --request GET \
--url https://{service}.{brand}.kych.co/v1/healthconst options = {method: 'GET'};
fetch('https://{service}.{brand}.kych.co/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://{service}.{brand}.kych.co/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;
}HttpResponse<String> response = Unirest.get("https://{service}.{brand}.kych.co/v1/health")
.asString();{
"status": "ok"
}{
"status": "unhealthy"
}System
Health check
Liveness check for monitors and load balancers. Unauthenticated and minimal by design — no API key should ever sit in a monitoring tool. Returns only a status; no versions or internals.
GET
https://{service}.{brand}.kych.co/v1
/
health
Health check
curl --request GET \
--url https://{service}.{brand}.kych.co/v1/healthconst options = {method: 'GET'};
fetch('https://{service}.{brand}.kych.co/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://{service}.{brand}.kych.co/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;
}HttpResponse<String> response = Unirest.get("https://{service}.{brand}.kych.co/v1/health")
.asString();{
"status": "ok"
}{
"status": "unhealthy"
}Response
Service is healthy.
Minimal liveness payload. Intentionally free of versions/internals.
Whether the service is currently able to serve requests.
Available options:
ok, unhealthy ⌘I