Skip to main content
PUT
cURL

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

PARTNER_NAME
string
required

Name of the proxy zone which will service your request.

Query Parameters

id
string
required

Valid customer id

zone
string
default:residential

Name of existing zone

Body

application/json
limit
integer
required

amount of bytes for the new limit

Example:

5242880000

unit
string
required

Limit unit

Example:

"bw"

period
string
required

Unit time for (only d is accepted)

Example:

"d"

period_mult
number
required

Days for limit period

Example:

10

Response

200 - application/json

OK

unit
string

Limit unit

Example:

"bw"

until
string
Example:

"2023-02-14T00:00:00.000Z"

start
string
Example:

"2022-11-15T00:00:00.000Z"

bust_action
string
Example:

"disable"

limit
integer

amount of bytes for the new limit

Example:

5242880000