Skip to main content
GET
/
api
/
v1
/
workers
/
health
Worker Health
curl --request GET \
  --url https://api.example.com/api/v1/workers/health
{
  "timestamp": "2025-01-15T14:00:00Z",
  "scheduler": {
    "running": true,
    "jobs": [
      {
        "id": "invoice_generation",
        "name": "Hourly Invoice Generation Check",
        "next_run_time": "2025-01-15T15:00:00Z",
        "trigger": "cron[hour='*', minute='0']"
      }
    ]
  },
  "workers": {
    "invoice_generator": {
      "status": "healthy",
      "consecutive_failures": 0,
      "last_run": "2025-01-15T14:00:00Z"
    },
    "invoice_finalizer": {
      "status": "healthy",
      "consecutive_failures": 0,
      "last_run": "2025-01-15T14:00:00Z"
    }
  },
  "overall_status": "healthy"
}
Returns real-time health status of all background workers and the APScheduler instance. 
{
  "timestamp": "2025-01-15T14:00:00Z",
  "scheduler": {
    "running": true,
    "jobs": [
      {
        "id": "invoice_generation",
        "name": "Hourly Invoice Generation Check",
        "next_run_time": "2025-01-15T15:00:00Z",
        "trigger": "cron[hour='*', minute='0']"
      }
    ]
  },
  "workers": {
    "invoice_generator": {
      "status": "healthy",
      "consecutive_failures": 0,
      "last_run": "2025-01-15T14:00:00Z"
    },
    "invoice_finalizer": {
      "status": "healthy",
      "consecutive_failures": 0,
      "last_run": "2025-01-15T14:00:00Z"
    }
  },
  "overall_status": "healthy"
}