Health
Overview
Monitor the operational status and uptime of the VeriWorkly ecosystem.
Description
The Health API provides a unified endpoint for monitoring the vital signs of the VeriWorkly infrastructure. It doesn't just check if the server is "up"—it performs deep health checks across all core dependencies to ensure the platform is fully operational.
Use this endpoint for uptime monitoring services (like UptimeRobot or BetterStack) and for automated deployment health-checks in CI/CD pipelines.
Checks Performed
The health report includes status for the following components:
- Server Runtime: Confirms the Node.js environment is responsive.
- Database (Prisma): Verifies active connectivity to our Neon PostgreSQL cluster.
- Cache (Redis): Ensures the rate-limiting and session cache is accessible.
- Environment: Validates that critical secrets and configurations are loaded.
Authentication
| Method | Access Level | Requirement |
|---|---|---|
GET | Public | None. This endpoint is public to allow external monitoring services to query it. |