Overview
API References
- Proxy
- Proxy Manager
- Web Unlocker & SERP API
- Web Scraper IDE API
- Web Scraper API
- Scraping Shield
- Account Management API
- POSTAdd a Zone
- POSTAllowlist/Denylist Domain(s)
- POSTDenylist IP(s)
- POSTAllowlist 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 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
- POST
- Marketplace Dataset API
Native Access
- Proxy
- Unlocker & SERP API
Account Management API
Zone info
Get Zone status
GET
/
zone
curl --request GET \
--url https://api.brightdata.com/zone \
--header 'Authorization: Bearer <token>'
{
"created": "2024-10-28T15:58:10.593Z",
"password": [
"zone-passowrd"
],
"ips": [
"any"
],
"plan": {
"start": "2024-10-31T13:38:23.665Z",
"product": "dc",
"type": "static",
"ip_fallback": 1,
"ips_type": "shared",
"ips": 120,
"bandwidth": "unlimited",
"unl_bw_tiers": "std",
"auto_cost_override": {
"ip_bw": 1,
"price_group": "shared"
}
},
"description": "hash",
"perm": "country"
}
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.
Query Parameters
Zone Info
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.brightdata.com/zone \
--header 'Authorization: Bearer <token>'
{
"created": "2024-10-28T15:58:10.593Z",
"password": [
"zone-passowrd"
],
"ips": [
"any"
],
"plan": {
"start": "2024-10-31T13:38:23.665Z",
"product": "dc",
"type": "static",
"ip_fallback": 1,
"ips_type": "shared",
"ips": 120,
"bandwidth": "unlimited",
"unl_bw_tiers": "std",
"auto_cost_override": {
"ip_bw": 1,
"price_group": "shared"
}
},
"description": "hash",
"perm": "country"
}
Assistant
Responses are generated using AI and may contain mistakes.