GET
/v1/health
Public
Returns real-time service status for TrueEntropy, including entropy pool depth, database connectivity, IBM Quantum backend state, and active connection metrics. This is a public endpoint - no API key required - and can be used for uptime monitoring and status dashboards.
Authentication
None required. This endpoint is deliberately public so third-party monitoring tools (StatusCake, UptimeRobot, Pingdom, etc.) can probe it without credentials.
Parameters
This endpoint accepts no parameters.
Code Examples
Terminal
curl https://api.trueentropy.net/v1/health
health.py
import requests
resp = requests.get("https://api.trueentropy.net/v1/health")
health = resp.json()["data"]
print(health["status"])
# "operational"
print(health["checks"]["entropy_pool"]["fill_percentage"])
health.js
const resp = await fetch('https://api.trueentropy.net/v1/health');
const { data } = await resp.json();
console.log(data.status);
console.log(data.checks.ibm_quantum.active_backend);
health.php
$resp = file_get_contents('https://api.trueentropy.net/v1/health');
$data = json_decode($resp, true)['data'];
echo $data['status'];
Response
200 OKJSON
{
"data": {
"status": "operational",
"version": "1.0.0",
"qubitlang_version": "1.4.0",
"checks": {
"api": { "status": "healthy", "latency_ms": 4.2 },
"entropy_pool": {
"status": "healthy",
"current_depth": 58432,
"target_depth": 65536,
"fill_percentage": 89.17,
"total_generated": 12485632,
"total_consumed": 12427200
},
"ibm_quantum": {
"status": "connected",
"active_backend": "ibm_fez",
"processor": "Heron (156 qubits)",
"last_successful_job": "2026-04-25T19:03:22Z"
},
"database": { "status": "healthy", "latency_ms": 1.8 },
"qubitlang": {
"status": "ready",
"version": "1.4.0",
"active_circuit": "qrng_hadamard_v2.3"
},
"connections": {
"status": "healthy",
"active_count": 12
}
}
},
"metadata": {
"timestamp": "2026-04-25T20:05:18Z",
"powered_by": "QuBitLang"
}
}
Overall Status Values
| Value | Meaning |
|---|---|
operational | All critical subsystems are healthy |
degraded | Some subsystems are running below target (e.g. low pool fill) but requests still succeed |
major_outage | Entropy pool empty AND database unavailable - requests will fail |
Subsystem Statuses
| Subsystem | Possible Values |
|---|---|
entropy_pool.status | healthy, degraded, low, empty |
ibm_quantum.status | connected, unknown |
database.status | healthy, unavailable |
connections.status | healthy (<100), busy (<500), congested (≥500) |
Use Cases
- Uptime monitoring - Point StatusCake / UptimeRobot / Pingdom at this URL and alert on non-200 responses or
status != "operational" - Pre-request probes - Fetch health before large batch jobs to avoid wasted retries if the pool is empty
- Status page - Our public status page polls this endpoint every 30 seconds