Skip to main content
POST
Pause a Scraper Studio job
Temporarily stop a running Bright Data Scraper Studio job. The job stops processing new inputs and moves to paused, and you can restart it later with Resume a Scraper Studio job. 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.

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 pause:
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

  • Hold a large batch during a target site incident, then resume once the site recovers
  • Free concurrency for higher-priority work during a maintenance window
  • Stop a job that is returning a high rate of blocked or detect_block errors while you adjust country, session or rate settings
To stop a job permanently instead, use Cancel a Scraper Studio job.

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 pause

Response

Job paused successfully

The response is of type string.