Skip to main content
DELETE
/
crawl
/
{jobId}
Cancel Crawl Job
curl --request DELETE \
  --url https://api.spidra.io/api/crawl/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "status": "cancelled",
  "jobId": "f3c2a1b0-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
}
Stops a crawl job that is queued or currently running. Pages that were already processed before the cancellation are preserved — you can still retrieve them with GET /crawl//pages. The job status moves to cancelled. Cancelling a job that has already reached a terminal state (completed, failed, or cancelled) returns a 400.

Example Request

curl -X DELETE https://api.spidra.io/api/crawl/abc-123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "status": "cancelled",
  "jobId": "abc-123"
}

Retrieving Partial Results

After cancelling, call GET /crawl//pages to retrieve any pages that completed before the job was stopped.
curl https://api.spidra.io/api/crawl/abc-123/pages \
  -H "Authorization: Bearer YOUR_API_KEY"
Only pages with status: "success" will have data. Any pages that were mid-flight when the job was cancelled will not appear.

Authorizations

Authorization
string
header
required

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

Path Parameters

jobId
string
required

The job ID to cancel

Response

Job cancelled

status
enum<string>
Available options:
cancelled
jobId
string