Batch

Cancel a batch and its unstarted child jobs

delete/batch/{jobId}

Request

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

Response

Batch is terminal or was cancelled.

jobIdstring uuid required
kind'batch' | 'crawl'
status'pending' | 'processing' | 'retrying' | 'done' | 'error' | 'cancel_requested' | 'cancelled' required
parentJobIdstring uuid nullable
createdAtstring date-time
startedAtstring date-time nullable
doneAtstring date-time nullable
resultunknown
resultSummaryobject
metadataobject

Changes

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