Authentication
API key
A secure method used for sending requests via the Bright Data API. Using the key is required for sending API requests.
An API key created automatically when the account is created, you can find it in the Account settings.
Generating an API key:
Sign In
Sign in to Bright Data’s control panel and navigate to your Account settings
Click 'Add API key'
Click on the ‘Add API key’ button in the top right of the API key section.
If the ‘API key’ section is not visible, switch to your admin account. You need to be logged in as admin to generate an API key from the settings page.
Configure your API key
Configure your User, Permissions, and API key Expiration date (Or ‘Unlimited’), then click ‘Save’
Save your API key locally
Once your API key has been generated make sure to save it locally to a secure location, as it will be presented only once!
Once you’ve created your API key, it cannot be viewed again. However, you can refresh it, update its expiration date, or revoke it at any time from your account settings.
When creating an API key, you can assign one of five permission levels to control access and ensure security based on user roles or use cases. Read more about user roles here.
Zone password
Each zone has a unique password used to authenticate API or native access requests. To find or update your zone password, follow these steps:
Go to My zones your proxy
Navigate to the Configuration tab.
Scroll down to the Security Settings section and expand it.
Copy your current password or update it as needed.
Zone name
The zone name is auto-generated when a new zone is created. You can review all zone names by visiting My zones.
Account ID
Your Account ID is a unique identifier automatically generated when your Bright Data account is created. It is used for authentication and account-related operations.
To locate your Account ID, follow these steps:
Click on Account Settings in the left-hand menu.
Go to the Profile tab.
Locate and copy your Account ID.
Note: In Bright Data, the Account ID is a text string that always begins hl_###.
Account ID in Bright Data is a text string always begin with hl_###