Health Checks

GridWork HQ exposes health check endpoints on both the dashboard and the pipeline server. Use these to verify the system is running and to integrate with external monitoring services.

Dashboard Health Endpoint

GET /api/health/check

Returns the dashboard application status and a timestamp.

Response (200 OK):

{
  "status": "ok",
  "timestamp": "2026-03-24T12:00:00.000Z"
}

This endpoint does not require authentication, so it can be called by external monitoring tools without a session or API key.

Pipeline Server Health Endpoint

GET http://localhost:8750/health

Returns the pipeline server status. This is the only pipeline server route that does not require a Bearer token.

Response (200 OK):

{
  "status": "ok",
  "uptime": 86400,
  "pipelines": {
    "running": 1,
    "queued": 0,
    "max": 3
  }
}

Expected Status Codes

Integrating with External Monitoring

GridWork HQ works with any HTTP-based monitoring service. Common options:

UptimeRobot

1. Create a new monitor with type HTTP(s)
2. Set the URL to https://your-domain.com/api/health/check
3. Set the monitoring interval to 5 minutes
4. Configure alerts (email, Slack, SMS) for downtime

Pingdom

1. Add an uptime check pointing to /api/health/check
2. Set the expected response string to "ok"
3. Choose your preferred check interval

Self-Hosted (curl)

For a simple cron-based check:

# Check dashboard health every 5 minutes
*/5 * * * * curl -sf https://your-domain.com/api/health/check || echo "Dashboard down" | mail -s "Alert" you@example.com

# Check pipeline server health
*/5 * * * * curl -sf http://localhost:8750/health || echo "Pipeline server down" | mail -s "Alert" you@example.com

Recommended Monitoring Intervals

Ops Monitor Page

The Ops Monitor dashboard page provides a visual overview of system health, including pipeline server status, integration connectivity, and resource usage — all accessible from the sidebar without leaving the dashboard.