- Proxy
- Proxy Manager
- Web Unlocker & SERP API
- Web Scraper IDE API
- Web Scraper API
- Scraping Shield
- Account Management API
- POSTAdd a Zone
- POSTWhitelist/Blacklist Domain(s)
- POSTBlacklist IP(s)
- POSTWhitelist IP(s)
- POSTAdd Static IP(s)
- POSTMigrate Static IPs between zones
- POSTRefresh dedicated residential IPs
- POSTRefresh Static IPs (Datacenter/ISP)
- PUTChange Account Status
- GETAccount status
- GETActive Zones
- GETAvailable IPs/Zone
- GETAvailable Datacenter & ISP IPs count
- GETGet Countries
- GETGet Country Cities
- GETGet current service status
- GETList all available country's cities (static network)
- GETRecent IPs attempting to use your Zone
- GETAvailable Datacenter & ISP IPs/Zone
- GETBandwidth stats for a zone
- GETBandwidth stats for all your zones
- GETTotal cost & bandwidth for a zone
- GETList of blacklisted IPs for a zone
- GETList of whitelisted IPs for a zone
- GETLive status of Static Zone
- GETTotal Balance
- GETZone info
- GETZone Password
- GETZone Permission
- GETZone Statistics
- GETZone status
- GETGet Proxies Pending Replacement
- DELRemove dedicated residential IPs
- DELRemove domain from Zone whitelist/blacklist
- DELRemove IP from Zone blacklist
- DELRemove IP from Zone whitelist
- DELRemove Static IPs (Datacenter/ISP)
- DELRemove a Zone
- POSTSwitch 100% uptime
- POSTTurn on/off Zone
- POST
- Marketplace Dataset API
Add a Zone
Add a new zone
curl --request POST \
--url https://api.brightdata.com/zone \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"zone": {
"name": "zone-name",
"type": "serp"
},
"plan": {
"type": "static",
"domain_whitelist": "<string>",
"ips_type": "shared",
"bandwidth": "bandwidth",
"ip_alloc_preset": "shared_block",
"ips": 0,
"country": "any",
"country_city": "any",
"mobile": "false",
"serp": "false",
"city": "false",
"asn": "false",
"vip": "false",
"vips_type": "shared",
"vips": "0",
"vip_country": "<string>",
"vip_country_city": "any"
}
}'Paste your API token to the authorization field. To get a token, Create an account and learn how to generate a token
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
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
Was this page helpful?
curl --request POST \
--url https://api.brightdata.com/zone \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"zone": {
"name": "zone-name",
"type": "serp"
},
"plan": {
"type": "static",
"domain_whitelist": "<string>",
"ips_type": "shared",
"bandwidth": "bandwidth",
"ip_alloc_preset": "shared_block",
"ips": 0,
"country": "any",
"country_city": "any",
"mobile": "false",
"serp": "false",
"city": "false",
"asn": "false",
"vip": "false",
"vips_type": "shared",
"vips": "0",
"vip_country": "<string>",
"vip_country_city": "any"
}
}'