Skip to content
Meta

Liveness probe

GET
/health
const url = 'https://api.kirim.chat/v1/health';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}

Unauthenticated health check. Returns 200 if the API is up.

API is healthy

Media type application/json
object
data
required
object
status
required
string
Allowed values: ok
request_id
required
string
Example
{
"data": {
"status": "ok"
}
}