Skip to content

Health ​

Check server status and dependencies.

Health check ​

GET /health

Response 200 OK

json
{
  "status": "ok",
  "version": "1.0.0",
  "mongo": "ok"
}
statusMeaning
okAll systems operational
degradedMongoDB unreachable

Use for load balancer health checks and Kubernetes liveness probes.

Version ​

GET /version
json
{
  "version": "1.0.0"
}

Error format ​

All API errors follow this shape:

json
{
  "error": "short description",
  "message": "detailed error message"
}
CodeMeaning
400Invalid request
401Missing or invalid API key
404Not found
409Document not yet indexed
429Rate limit exceeded
500Internal error

Released under the MIT License.