Bright Data Docs home page

Sign up
Requests
Submit request
Sign up

Account Management API

Add a Zone

Proxy

Proxy Manager

Web Unlocker

Web Scraper IDE API

Marketplace Dataset API

Scraping Shield

Account Management API

POST
Add a Zone
POST
Whitelist/Blacklist Domain(s)
POST
Blacklist IP(s)
POST
Whitelist IP(s)
Add Static IP(s)
Migrate Static IPs between zones
Refresh dedicated residential IPs
Refresh Static IPs (Datacenter/ISP)
Change Account Status
GET
Account status
GET
Active Zones
GET
Available IPs/Zone
Available Datacenter & ISP IPs count
Get country cities
Get current service status
List all available country's cities (static network)
Recent IPs attempting to use your Zone
Available Datacenter & ISP IPs/Zone
Bandwidth stats for a zone
Bandwidth stats for all your zones
Total cost & bandwidht for a zone
List of blacklisted IPs for a zone
List of whitelisted IPs for a zone
Live status of Static Zone
Total Balance
GET
Zone info
GET
Zone Password
GET
Zone Permission
Zone Statistics
GET
Zone status
Remove dedicated residential IPs
Remove domain from Zone whitelist/blacklist
Remove IP from Zone blacklist
Remove IP from Zone whitelist
Remove Static IPs (Datacenter/ISP)
Remove a Zone
POST
Switch 100% uptime
Turn on/off Zone

SERP API

Account Management API

Add a Zone

Add a new zone

POST

zone

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

object

zone

object

zone

Required

object

Add Example Value

name

string

name

Required

string

The name of the zone

type

string

type

string

Zone Type, e.g. serp, isp, mobile, etc.

plan

object

plan

Required

object

type

enum<string>

type

Required

enum<string>

type of zone

domain_whitelist

string

domain_whitelist

string

Space separated list of whitelisted domains

ips_type

enum<string>

ips_type

enum<string>

domain_whitelist is required for selective

bandwidth

enum<string>

bandwidth

enum<string>

bandwidth: for bandwidth unlimited: enable unlimited bandwidth

ip_alloc_preset

enum<string>

ip_alloc_preset

enum<string>

To set a zone with Shared - Pay per usage type

ips

integer

ips

integer

Number of static IPs to allocate to the zone

country

string

country

string

Specify which country IP to allocate to the zone, specify this parameter when ips_type=static

country_city

string

country_city

string

Country code followed by city (e.g. “se-stockholm”) - specify which City IP to allocate to the zone, specify this parameter when ips_type=static

mobile

boolean

mobile

boolean

true when adding a Mobile proxy zone, type value must be resident

serp

boolean

serp

boolean

true when adding a SERP API zone

city

boolean

city

boolean

true when enabling City targeting permission

asn

boolean

asn

boolean

true when enabling ASN targeting permission

vip

boolean

vip

boolean

true when allocating gIP (group of IPs)

vips_type

enum<string>

vips_type

enum<string>

specify this parameter when adding a Residential or Mobile zone

vips

integer

vips

integer

Number of gIP (group of IPs) to allocate to the zone

vip_country

string

vip_country

string

Specify which country IP to allocate to the zone, specify this parameter when ips_type=resident and vip=true

vip_country_city

string

vip_country_city

string

Country code followed by city (e.g. “se-stockholm”) - specify which City IP to allocate to the zone, specify this parameter when ips_type=resident and vip=true

Paste your API token to the authorization field. To get a token, Create an account and learn how to generate a token

Add a Plan Examples

Add a Datacenter Shared - Pay per Usage zone

curl "https://api.brightdata.com/zone" -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d "{'zone':{'name':'zone_name'},'plan':{'type':'static','ips_type':'shared','ip_alloc_preset':'shared_block'}}"

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

zone

object

required

zone.name

string

required

The name of the zone

zone.type

string

Zone Type, e.g. serp, isp, mobile, etc.

plan

object

required

plan.type

enum<string>

required

type of zone

Available options:

static,

resident,

unblocker

plan.domain_whitelist

string

Space separated list of whitelisted domains

plan.ips_type

enum<string>

domain_whitelist is required for selective

Available options:

shared,

dedicated,

selective

plan.bandwidth

enum<string>

bandwidth: for bandwidth unlimited: enable unlimited bandwidth

Available options:

bandwidth,

unlimited

plan.ip_alloc_preset

enum<string>

To set a zone with Shared - Pay per usage type

Available options:

shared_block,

shared_res_block

plan.ips

integer

default: 0

Number of static IPs to allocate to the zone

plan.country

string

default: any

Specify which country IP to allocate to the zone, specify this parameter when ips_type=static

plan.country_city

string

default: any

Country code followed by city (e.g. “se-stockholm”) - specify which City IP to allocate to the zone, specify this parameter when ips_type=static

plan.mobile

boolean

default: false

true when adding a Mobile proxy zone, type value must be resident

plan.serp

boolean

default: false

true when adding a SERP API zone

plan.city

boolean

default: false

true when enabling City targeting permission

plan.asn

boolean

default: false

true when enabling ASN targeting permission

plan.vip

boolean

default: false

true when allocating gIP (group of IPs)

plan.vips_type

enum<string>

specify this parameter when adding a Residential or Mobile zone

Available options:

shared,

domain

plan.vips

integer

default: 0

Number of gIP (group of IPs) to allocate to the zone

plan.vip_country

string

Specify which country IP to allocate to the zone, specify this parameter when ips_type=resident and vip=true

plan.vip_country_city

string

default: any

Country code followed by city (e.g. “se-stockholm”) - specify which City IP to allocate to the zone, specify this parameter when ips_type=resident and vip=true

Samples by classification data Whitelist/Blacklist Domain(s)

linkedin youtube github

​Add a Plan Examples

Authorizations

Body

Add a Plan Examples