System

Liveness probe

GET/healthNo authentication

Public, unauthenticated. Returns a fixed status and the API version, and nothing about tenants, sessions or load.

Responses

200The gateway is up
Response fields
- statusstringrequired
  One of: ok
- versionstringrequired
  API version, e.g. 1.0.0

Request

curl "https://api.chatkomodo.com/health"

const res = await fetch('https://api.chatkomodo.com/health', {
  method: 'GET',
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.error}`);
console.log(data);

import os
import requests

res = requests.get(
    "https://api.chatkomodo.com/health",
    timeout=30,
)
res.raise_for_status()
print(res.json())

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();
$res = $client->request('GET', 'https://api.chatkomodo.com/health', [
]);

print_r(json_decode((string) $res->getBody(), true));

Response 200

{
  "status": "ok",
  "version": "string"
}