Jobs

Request cancellation of a durable job

Cancellation is cooperative. Work already running may finish, while unstarted children are cancelled without consuming page quota.

Work already in flight is still charged. A capture is claimed by its worker within about a second of submission, so a cancellation for a single capture almost always arrives after the browser has started and that capture is billed as a completed one; the credit is not refunded. What cancellation saves is the unstarted remainder — for a batch or crawl, every child that had not yet been claimed. Read the response's counts rather than assuming a cancelled job cost nothing, and treat GET /credits as authoritative for what was actually spent.

delete/job/{jobId}

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/job/{jobId}
  • Auth: API key in header x-api-key

Response

The job was already terminal or cancellation completed.

status'pending' | 'processing' | 'retrying' | 'done' | 'error' | 'cancel_requested' | 'cancelled' required
jobIdstring uuid required
createdAtstring date-time
startedAtstring date-time nullable
doneAtstring date-time nullable
completedAtstring date-time nullable
messagestring
codestring
suggestionsstring[]
recoveredboolean
cancellationRequestedAtstring date-time nullable
acceptedboolean

Present on a successful cooperative cancellation response.

Changes

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