Connecting to BrightData

Using API Key Authentication

To use the Bright Data API, you need an API key from the Bright Data Control Panel. Navigate to Account Settings > API to generate or retrieve your API key.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to APIKey.
APIKey: Set this to your Bright Data API key from the Control Panel.

Example connection string:

Profile=C:\profiles\BrightData.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Available Tables

The Bright Data API Profile provides access to proxy zone management, network monitoring, dataset catalog, and browser session operations across 10 specialized tables:

Zones - List all proxy zones in the Bright Data account, including active and deleted zones, with their type and status.
ZoneDetails - Retrieve detailed configuration and plan information for a specific zone. Requires the Zone name as a parameter.
AccountStatus - Return the operational status and authentication state of the Bright Data account.
NetworkStatus - Return the operational status for a specific Bright Data network type (res, dc, or mobile). Requires NetworkType as a parameter.
AvailableCountries - Return the list of available ISO 3166-1 alpha-2 country codes for each Bright Data zone type (DC shared/dedicated, ISP shared/dedicated).
Datasets - List all available datasets in the Bright Data catalog with their identifiers, names, and record counts.
DatasetSnapshots - List dataset snapshots for a specific dataset, with optional filtering by status, date, and trigger type. Requires DatasetId as a parameter.
SnapshotDetails - Retrieve detailed metadata for a specific dataset snapshot by ID. Requires the snapshot Id as a parameter.
BrowserSessions - List browser scraping sessions from the Bright Data Browser API, with filtering by status, zone, URL, and date range.
ShieldClassifications - Return request classification data from the Bright Data Scraping Shield. Requires the Scraping Shield product to be enabled on the account.

Usage Examples

AccountStatus:

SELECT * FROM AccountStatus

AvailableCountries:

SELECT * FROM AvailableCountries

BrowserSessions:

SELECT * FROM BrowserSessions

DatasetSnapshots:

SELECT * FROM DatasetSnapshots WHERE DatasetId = 'gd_l1vijqt9jfj7olije'

Datasets:

SELECT * FROM Datasets

NetworkStatus:

SELECT * FROM NetworkStatus WHERE NetworkType = 'res'

ShieldClassifications:

SELECT * FROM ShieldClassifications

SnapshotDetails:

SELECT * FROM SnapshotDetails WHERE Id = 'snapshot_id'

ZoneDetails:

SELECT * FROM ZoneDetails WHERE Zone = 'zone_name'

Zones:

SELECT * FROM Zones

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	Your Bright Data API key used for Bearer token authentication.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT