Proxy
Proxy Manager
Web Unlocker
SERP API
Web Scraper IDE API
Marketplace Dateset API
Scraping Shield
Account Management API
- POSTAdd a Zone
- POSTWhitelist/Blacklist Domain(s)
- POSTBlackist IP(s)
- POSTWhitelist IP(s)
- Add Static IP(s)
- Migrate Static IPs between zones
- Refresh dedicated residential IPs
- Refresh Static IPs (Datacenter/ISP)
- Change Account Status
- GETAccount status
- GETActive Zones
- GETAvailable 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
- GETZone info
- GETZone Password
- GETZone Permission
- Zone Statistics
- GETZone 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
- POSTSwitch 100% uptime
- Turn on/off Zone
- POST
Add a Zone
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The name of the zone
Zone Type, e.g. serp, isp, mobile, etc.
type of zone
Space separated list of whitelisted domains
domain_whitelist is required for selective
bandwidth: for bandwidth unlimited: enable unlimited bandwidth
To set a zone with Shared - Pay per usage type
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
Number of gIP (group of IPs) to allocate to the zone
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
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}}"
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
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The name of the zone
Zone Type, e.g. serp, isp, mobile, etc.
type of zone
static, resident, unblocker Space separated list of whitelisted domains
domain_whitelist is required for selective
shared, dedicated, selective bandwidth: for bandwidth unlimited: enable unlimited bandwidth
bandwidth, unlimited To set a zone with Shared - Pay per usage type
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
shared, domain Number of gIP (group of IPs) to allocate to the zone
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
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}}"