Cancel a Batch Job

DELETE /v1/batch/{job_id} cancels a batch job that is still queued or processing. Cancellation stops new batch items from being scheduled. Items already in flight may continue briefly while they drain.

Use this endpoint when a batch was started by mistake, no longer matters, or is taking a path you do not want to continue.

Request

Replace the example job ID with the batch job_id you want to cancel.

export SCRAPER_API_BASE_URL="https://scraper.geonode.io"
export GEONODE_SCRAPER_API_KEY="YOUR_API_KEY"

curl -X DELETE "$SCRAPER_API_BASE_URL/v1/batch/9d7b2c8e-8a4b-4c10-9af3-65f4f8f6c019" \
  -H "X-Api-Key: $GEONODE_SCRAPER_API_KEY"

Response

A successful cancellation returns 202 with the cancelled job ID and the number of items still draining.

{
  "job_id": "9d7b2c8e-8a4b-4c10-9af3-65f4f8f6c019",
  "status": "cancelled",
  "status_url": "/v1/batch/9d7b2c8e-8a4b-4c10-9af3-65f4f8f6c019",
  "in_flight_urls": 0
}

If the job is already completed or cannot be cancelled in its current state, the API can return 409.