DevGuard System API
Two endpoints for operating the instance rather than using it.
GET /health is the liveness and readiness check. It is what a container orchestrator, load balancer or uptime monitor should poll: cheap, frequent, and answering only whether this instance is able to serve traffic right now.
GET /info returns diagnostics — runtime details, build information and database status. It is the first thing to look at when confirming which version an environment is actually running, or when a deployment behaves differently from the one next to it.
Because they are used by infrastructure that has no credentials, these endpoints sit outside the normal authentication scheme. Keep that in mind when exposing an instance publicly: /info reveals version and build detail, so restrict it at the ingress if that matters to you.
Related Documentation
- Monitoring & Metrics — wiring these into your monitoring
- Deploy with Helm — where the probes are configured
- Deploy with Docker — the equivalent for Compose
- Upgrade DevGuard — confirming a version after upgrade
- Restricting Access — limiting who can reach
/info - Use the DevGuard API — authentication and conventions
- DevGuard API Reference