POST
/
request
See instruction on how to create API Token: API Token creation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
format
enum<string>
required

Format for requesting a raw HTML via proxy is raw.

Format for request a JSON response is json.

Available options:
raw,
json
url
string
required

Target URL for your request.

zone
string
required

Name of the proxy zone which will service your request.

ASN
string

ASN code which request is relayed thru, must have country defined.

Supported in Residential networks only.

c_tag
string

Include a unique c_tag flag in their requests. In response, businesses echo back the same tag in the header. This seamless exchange ensures that each response is bound to its corresponding request, eliminating confusion and streamlining data management.

carrier
string

For mobile network only: carrier code in which request is relayed through.

Supported in mobile networks only.

city
string

City name of proxy which request is relayed through, must have country defined.

Supported in DC & ISP for zones pre-configured with cities, and in Residential and mobile networks by default.

country
string

Country code of proxy which request is relayed through.

direct
boolean

Setting the parameter to true will instruct to process the request by Bright Data super proxy, a datacenter located proxy and not the proxy peer itself.

dns
enum<string>

Use local or remote to set if domain name mapping is done locally on client side or on remote proxy peer.

Available options:
local,
remote
gip
string

In Residential and Mobile zones: Relay the request to a specific proxy group identified by the gip.

ip
string

In Datacenter and ISP zones: Relay the request to a specific proxy identified by the ip.

method
string
default:
GET

Method for requesting an HTML via proxy is GET.

os
string

Operating system of the client to set on proxy.

Supported in mobile networks only.

session
string

A string relayed by the client to mark a session, all requests with the same session parameter will be relayed to the same proxy peer.

zip
string

Zip code which request is relayed through, must have country defined.

Supported in Residential networks only.

Response

200 - application/json

The response is of type string.