Skip to main content
POST
Cancel a Scraper Studio job
Permanently stop a Bright Data Scraper Studio job. The job moves to canceled and stops processing its remaining inputs. This endpoint takes no request body and returns the plain text body OK on success, not JSON. Read the response as text rather than calling a JSON parser on it.
Canceling is permanent. A canceled job cannot be resumed. Data already collected may still be available, depending on the run status and delivery settings. To stop a job temporarily instead, use Pause a Scraper Studio job.

Job state behavior

Completed jobs cannot be paused, resumed or canceled.

How to find a job ID

Use the jobs list endpoint to find the ID of the job you want to cancel:
Use the returned id value as the job_id path parameter. See List Scraper Studio jobs for the full parameter list.

When to use this endpoint

  • Stop a job triggered with the wrong input set instead of paying for the full run
  • Cancel a runaway job generating far more child pages than expected, rather than waiting for a too_many_pages error
  • Clear a stuck job before triggering a corrected run of the same scraper
Pages that were still queued when the job was canceled report the aborted_page error code. See Scraper Studio error codes for the full catalog.

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Path Parameters

job_id
string
required

ID of the job to cancel

Response

Job canceled successfully

The response is of type string.