Bright Data's API Token

Bright Data’s API token 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 token is required for certain API requests where noted.

An API token 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 token from the settings page

1. Sign In

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

2. Click 'Add token'

   Click on the ‘Add token’ button in the top right of the API token section.

   If the ‘API tokens’ section is not visible, switch to your admin account. You need to be logged in as admin to generate an API token from the settings page.

3. Configure your Token

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

4. Save your Token locally

   Once your token 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 token, 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 Token Permissions

There are 5 types of permissions to choose from to control API token 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 whitelists/blacklists.

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

Using the API token authentication option with Proxy products

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

You can find the token 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 token authentication, please refer to this guide.