Jobs

Cancel an in-flight async job

Requests cancellation of jobId. When a job is cancellable the runner flips the record to cancelled, cancels the underlying task so the body actually stops, and emits a terminal job.complete SSE event; the updated WireJobRecord is returned. A job that does not exist or is already terminal returns 404 ("nothing to cancel").

post/v1/jobs/{jobId}/cancel

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/jobs/{jobId}/cancel
  • Auth: HTTP bearer

Path parameters

jobIdstring required

Identifier of the job to cancel.

Response

Job cancelled

idstring required

Stable job identifier (returned when the job was enqueued).

verbstring required

The async verb this job runs (e.g. the transform/capture name).

state'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

Lifecycle state of an async job.

progressnumber double required

Completion percent (0–100).

startedAtstring required

ISO-8601 timestamp when the job started.

finishedAtstring nullable

ISO-8601 timestamp when the job reached a terminal state; null while running.

errorstring nullable

Failure message when state is failed; null otherwise.

outputAssetIdstring nullable

Asset id of the produced output when state is completed; null otherwise.

Changes

No recorded changes to this operation across all 1 revision of this API.