Overview
Unlocker
SERP
Marketplace Dataset API
Web Scraper - Delivery APIs
Web Scraper - Management APIs
Web Scraper IDE API
Scraping Shield
Account Management API
- POSTAdd a Zone
- POSTAllow/Deny Domains
- POSTDenylist IP(s)
- POSTAllowlist IP(s)
- POSTAdd Static IP(s)
- POSTMigrate Static IPs
- 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 denylisted IPs for a zone
- GETList of allowlisted 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 allowlist/denylist
- DELRemove IP from Zone denylist
- DELRemove IP from Zone allowlist
- DELRemove Static IPs (Datacenter/ISP)
- DELRemove a Zone
- POSTSwitch Automatic Failover
- POSTTurn on/off Zone
API Reference
- Proxy
- Proxy Manager
- Web Scraper API
Native Access
- Proxy
- Unlocker & SERP API
Account Management API
Add a Zone
Add a new zone
POST
/
zone
cURL
Copy
Ask AI
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"
}
}'
Warning: This API can modify your account settings, damage your operations or incur charges.
Paste your API key to the authorization field. To get an API key, Create an account and learn how to generate an API key
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
Zone added
Was this page helpful?
cURL
Copy
Ask AI
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"
}
}'
Assistant
Responses are generated using AI and may contain mistakes.