Health
Check health
Section titled “Check health”GET
/healthPublic: no key needed, not rate limited, and no customer data in the answer. Use it for uptime monitoring. Note the path has no /v1 prefix.
curl https://api.smsfabric.com/healthWhen everything is up, it returns 200:
{ "status": "ok", "db": "ok", "redis": "ok", "version": "1.4.0" }When the database or Redis doesn’t answer within 2 seconds, it returns 503:
{ "status": "degraded", "db": "ok", "redis": "error", "version": "1.4.0" }| Field | Values | Description |
|---|---|---|
status |
ok, degraded |
degraded when any dependency is down. |
db |
ok, error |
The database. |
redis |
ok, error |
The queue and cache. |
version |
string | The API version that answered. |
A 200 from /health means the API can accept requests. It doesn’t tell you whether your phones are online: check GET /v1/devices, or subscribe to device.offline.