Overview
Unlocker
SERP
Scraper
Marketplace Dataset API
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 IDE API
- Web Scraper API
- Scraping Shield
Native Access
- Proxy
- Unlocker & SERP API
Proxy
Proxy REST API Playground
Access proxy networks using REST API
POST
/
request
Copy
curl --request POST \
--url https://api.brightdata.com/request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"zone": "<string>",
"url": "<string>",
"format": "raw",
"method": "GET",
"country": "<string>",
"city": "<string>",
"zip": "<string>",
"ASN": "<string>",
"carrier": "<string>",
"os": "<string>",
"dns": "local",
"session": "<string>",
"ip": "<string>",
"gip": "<string>",
"c_tag": "<string>",
"direct": true
}'
Copy
"OK"
See instruction on how to create API key: API key creation
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
OK
The response is of type string
.
Example:
"OK"
Was this page helpful?
Copy
curl --request POST \
--url https://api.brightdata.com/request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"zone": "<string>",
"url": "<string>",
"format": "raw",
"method": "GET",
"country": "<string>",
"city": "<string>",
"zip": "<string>",
"ASN": "<string>",
"carrier": "<string>",
"os": "<string>",
"dns": "local",
"session": "<string>",
"ip": "<string>",
"gip": "<string>",
"c_tag": "<string>",
"direct": true
}'
Copy
"OK"
Assistant
Responses are generated using AI and may contain mistakes.