Skip to main content
POST
/
zone
/
ips
/
refresh
cURL
curl --request POST \
  --url https://api.brightdata.com/zone/ips/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "zone": "zone1",
  "vips": [
    "vip1",
    "vip2"
  ],
  "ips": [
    "ip1",
    "ip2"
  ],
  "country": "<string>",
  "country_city": "<string>"
}
'
{
  "vips": [
    {
      "vip": "tr_9121_07_antalya_10",
      "country": "tr"
    },
    {
      "vip": "tr_9121_07_antalya_17",
      "country": "tr"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Only users with Admin or Ops roles can perform this action.
Warning: This API can modify your account settings, damage your operations or incur charges.
Paste your API key to the authorization field. To get an API key, Create an account and learn how to generate an API key
Sample Response for Static IPs
{
    "ips":[
        "1.1.1.1",
        "1.1.1.2",
        "1.1.1.3"
    ],
    "new_ips":[
        "1.1.1.1",
        "1.1.1.3"
    ]
}

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:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

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

Body

application/json
​
zone
string
required

Zone name

Example:

"zone1"

​
vips
string[]

IPs to refresh

Note: If refresh is needed for all allocated IPs, then vips parameter should be omitted.

Note: Only works for Dedicated Residential IPs

Example:
["vip1", "vip2"]
​
ips
string[]

IPs to refresh

Note: If refresh is needed for all allocated IPs, then ips parameter should be omitted

Example:
["ip1", "ip2"]
​
country
string

new IPs' country (e.g. us)

​
country_city
string

new IPs' city (e.g. us-chicago)

Response

200 - application/json

OK

The response is of type object.