Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Path Parameters

PARTNER_NAME
string
required

Name of the proxy zone which will service your request.

Query Parameters

id
string
required

Valid customer id

zone
string
default:hq_static_res

Existing zone name

country
string

Name of country (e.g. us)

state
string

Name of the US country (e.g. ca)

session
number

Amount of the sessions to generate

asn
string

Name of the ASN. YOu can get all available ASNs via /api/{PARTNER_NAME}/get_asn API

carrier
string

Name of the carrier. You can get all available carriers via /api/{PARTNER_NAME}/carriers API

const
number
default:1

Use constant

split
number
default:1

If provided only brd-customer-{CUST_ID}-zone-{ZONE} part of username will be encoded

Response

200 - application/json

OK

Example: