Sign in
Jobs
Streaming

Stream job events (WebSocket)

Changed on

Upgrades to a WebSocket connection and streams real-time events for the specified job until it reaches a terminal state.

get/api/v1/jobs/{id}/stream

Request

  • Base URL: http://localhost:8081
  • URL: http://localhost:8081/api/v1/jobs/{id}/stream
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Job ID

Headers

X-Tenant-IDstring required

Tenant isolation header (required on all protected routes).

Changes

  • 12120aad0bfeRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status