DELETE
Cancel a crawl
Cancel a running crawl job started with POST /crawl. Has no effect on a crawl that has already reached a terminal state (completed, failed, or cancelled).

Path parameters

  • id (string, required): Crawl job ID returned by POST /crawl.

Responses

  • 200: Confirmation with the crawl’s final status (cancelled).
  • 404: Crawl job not found.
  • 409: Crawl already reached a terminal state.
  • 503: Crawling is unavailable or unconfigured on this orchestrator instance.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Crawl job ID returned by POST /crawl.

Response

Crawl cancelled

status
enum<string>
required

Current state of a crawl job.

Available options:
scraping,
completed,
failed,
cancelled