API reference
Health
One unauthenticated probe. It reports that the service answers and which storage class stands behind it. Nothing here needs a key.
GET /v1/health
Liveness and storage class
Reports that the service answers and which storage class stands behind it, so a probe does not take durability on faith.
Parameters
None.
Request body
None.
Example request
curl
curl -sS -X GET "https://api.afaprotocol.com/v1/health"Python
import requests
API = "https://api.afaprotocol.com"
r = requests.get(f"{API}/v1/health", timeout=30)
r.raise_for_status()
print(r.json())Example response
HTTP 200
{
"service": "afaprotocol",
"status": "ok",
"storage": "postgres",
"version": "0.1.0"
}Errors
No error responses beyond transport failures.
What would show this is false
storage reads memory on a deployment that lost its database. Production refuses to boot in that state, and this field is how you see it from outside.