Bright Data Docs home page

Sign up
Requests
Submit request
Sign up

Account Management API

Add a Zone

Scrape with APIs
API vs Native access

Proxy
Proxy Manager
Web Unlocker & SERP API
Web Scraper IDE API
Scraping Shield
Account Management API
Marketplace Dataset API

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

Warning: This API can modify your account settings, damage your operations or incur charges.

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

plan

object

required

Was this page helpful?

Samples by classification data Whitelist/Blacklist Domain(s)

linkedin youtube github

​Add a Plan Examples

Authorizations

Body

Add a Plan Examples