Health

Health check endpoint that reports the status of all workers.

This endpoint is only available for self-hosted Outpost deployments. Managed Outpost health is monitored by Hookdeck.

Worker status is one of:

  • healthy: running.
  • degraded: failing and being restarted, within its restart budget. The service keeps serving. Only reported for workers listed in SUPERVISOR_RESTART_WORKERS.
  • failed: failed, or failing past its restart budget. With restarts enabled, Outpost keeps restarting it, and it returns to healthy once it recovers.

Returns HTTP 200 when no worker has failed (the overall status is degraded if any worker is degraded), or HTTP 503 if any worker has failed.

Note: Error details are not exposed for security reasons. Check application logs for detailed error information.

get/healthz

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    none required

Response

Service is healthy or degraded - no worker has failed.

status'healthy' | 'degraded' required
timestampstring date-time required

When this health check was performed

workersobject required

Example response

{
  "status": "healthy",
  "timestamp": "2025-11-11T10:30:00Z"
}

Changes

    • warning

      added the new degraded enum value to the response property for the response status

    • warning

      added the new degraded enum value to the // response property for the response status

    • warning

      added the new degraded enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status