Bright Data’s API key is a secure method for replacing your credentials when sending requests via the Bright Data API, ensuring your account remains safe and secure. Additionally, the API key is required for certain API requests where noted.

An API key is created automatically when the account is created, you can find it in the Account settings or in the Zone overview section for Web-Unlocker/SERP-API zones.

​
Generate a new API key from the settings page

1

Sign In

Sign in to Bright Data’s control panel and navigate to your Account settings

2

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.

3

Configure your API key

Configure your User, Permissions, and API key Expiration date (Or ‘Unlimited’), then click ‘Save’

4

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, you won’t be able to view it again, however, you can still refresh it, change it’s expiration date, or revoke it at any time.

​
API key Permissions

There are 5 types of permissions to choose from to control API key access:

  • Admin: Grants full access to the account, including all Billing, Financial, product settings and configurations.

  • Finance: Allows access to Billing and Financial pages only.

  • Ops: Allows access to zone/product configurations but restricts Billing access.

  • Limit: Permits management of zone passwords and IP allowlists/denylists.

  • User: Enables API usage on the zone/product level without access to Billing or product configuration pages.

​
Using the API key authentication option with Proxy products

Currently Web-Unlocker and SERP-API are available with API key authentication.

You can find the API key in the Zone overview section while the API method is selected in your Zone.

For more info about working with Web-Unlocker/SERP-API with API key authentication, please refer to this guide.