Skip to main content

​
Get Health Status

curl -X GET 'http://localhost:8000/health'

​
Response

​
status
string
required
Overall service status. Always "healthy" if the server is responding.
​
service
string
required
Service name (“Nectr”).
​
version
string
required
Current API version (e.g., "0.2.0").
​
environment
string
required
Deployment environment ("development" or "production").
​
uptime_seconds
number
required
Seconds since server started.
​
database
string
required
PostgreSQL connection status: "healthy" or "unhealthy: <error>".
​
neo4j
string
required
Neo4j graph database status:
  • "healthy": Connected and operational
  • "not configured": Neo4j credentials not provided
  • "unhealthy: <error>": Connection failed

​
Example Response

{
  "status": "healthy",
  "service": "Nectr",
  "version": "0.2.0",
  "environment": "development",
  "uptime_seconds": 3847.2,
  "database": "healthy",
  "neo4j": "healthy"
}

​
Use Cases

  • Health probes: Use for Kubernetes liveness/readiness checks
  • Monitoring: Track uptime and dependency health
  • Debugging: Verify database and Neo4j connectivity

​
Notes

  • This endpoint does not require authentication
  • Returns 200 OK even if dependencies are unhealthy (check individual status fields)
  • Uptime resets on server restart

Build docs developers (and LLMs) love

Get started for freeTalk to us