Proxy
Proxy Manager
Web Unlocker
SERP API
Web Scraper IDE API
Marketplace Dateset API
Scraping Shield
Account Management API
- Add a Zone
- Whitelist/Blacklist Domain(s)
- Blackist IP(s)
- Whitelist IP(s)
- Add Static IP(s)
- Migrate Static IPs between zones
- Refresh dedicated residential IPs
- Refresh Static IPs (Datacenter/ISP)
- Change Account Status
- Account status
- Active Zones
- Available dedicated residential 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/Zoner
- 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
- Zone info
- Zone Password
- Zone Permission
- Zone Statistics
- 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
- Switch 100% uptime ON/OFF in a Static zone
- Turn on/off Zone
Add a Zone
Add a new 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|resident','ips_type':'shared|dedicated|selective','ip_alloc_preset':'shared_block','bandwidth':'payperusage|unlimited','mobile':false,'city':false,'asn':false,'vip':false,'vips_type':'shared|vip|domain','vips':0,'domain_whitelist':'test.com fb.com','not_country':null,'vip_country':'any','exclusive_sec':0,'exclusive_type':'days','exclusive_num':0,'ips':0}}"
{
"plan": {
"start": "2019-07-15T18:08:59.269Z",
"type": "static",
"ips_type": "shared",
"ip_alloc_preset": "shared_block",
"bandwidth": "payperusage"
},
"zone": {
"ips": "any",
"password": [
"PASSWORD"
],
"plans": [
{
"start": "2019-07-15T18:08:59.269Z",
"type": "static",
"ips_type": "shared",
"ip_alloc_preset": "shared_block",
"bandwidth": "payperusage"
}
]
}
}
API Endpoint: POST
/api/zone
Zone name
value | description |
---|---|
static | Datacenter, ISP |
resident | Residential, Mobile, SERP |
unblocker | Web Unlocker |
Space separated list of whitelisted domains
value | description |
---|---|
shared | Shared |
dedicated | Exclusive - All domain |
selective | Exclusvie - Exclusive domain specified domain_whitelist is required for selective |
value | description |
---|---|
bandwidth | for bandwidth |
unlimited | enable unlimited bandwidth, this setting will be applied only to Datacenter - Shared per IP or Exclusive types |
To set a zone with Shared - Pay per usage type
value | description |
---|---|
shared_block | |
shared_res_block |
Number of static IPs to allocate to the zone
Specify which country IP to allocate to the zone, specify this parameter when ips_type=static
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
true
when adding a Mobile proxy zone, type value must be resident
‘true’ when adding a SERP API zone
true
when enabling City targeting permission
true
when enabling ASN targeting permission
true
when allocating gIP (group of IPs)
specify this parameter when adding a Residential or Mobile zone
value | description |
---|---|
shared | Shared |
domain | Exclusive (domain_whitelist is required) |
Number of gIP (group of IPs) to allocate to the zone
Space separated list of whitelisted domains
Specify which country IP to allocate to the zone, specify this parameter when ips_type=resident
and vip=true
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
Add a Plan Examples
Datacenter
ISP
Residential
Mobile
Unlocker
SERP
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'}}"
curl "https://api.brightdata.com/zone" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer API_TOKEN" \
-d "{'zone':{'name':'ZONE_NAME'},'plan':{'type':'static|resident','ips_type':'shared|dedicated|selective','ip_alloc_preset':'shared_block','bandwidth':'payperusage|unlimited','mobile':false,'city':false,'asn':false,'vip':false,'vips_type':'shared|vip|domain','vips':0,'domain_whitelist':'test.com fb.com','not_country':null,'vip_country':'any','exclusive_sec':0,'exclusive_type':'days','exclusive_num':0,'ips':0}}"
{
"plan": {
"start": "2019-07-15T18:08:59.269Z",
"type": "static",
"ips_type": "shared",
"ip_alloc_preset": "shared_block",
"bandwidth": "payperusage"
},
"zone": {
"ips": "any",
"password": [
"PASSWORD"
],
"plans": [
{
"start": "2019-07-15T18:08:59.269Z",
"type": "static",
"ips_type": "shared",
"ip_alloc_preset": "shared_block",
"bandwidth": "payperusage"
}
]
}
}