The /brightdata command enables you to manage your BrightData proxy infrastructure and web scraping operations. Perfect for:

• Managing proxy zones
• Monitoring IP usage
• Configuring proxy settings
• Handling authentication
• Tracking billing and usage

​

Basic Usage

Use the command to interact with BrightData:

/brightdata check account status

/brightdata create residential zone "my_scraping_zone" for country "us"

/brightdata list all zones

​

Key Features

​

Account Management

• Check account status
• View billing information
• Monitor usage statistics
• Manage IP whitelist
• Generate API keys

​

Zone Operations

• Create new zones
• Update zone configurations
• List all zones
• Delete zones
• Check zone status

​

Proxy Configuration

• Get proxy settings
• Retrieve connection strings
• Manage authentication
• Configure zone access

​

Monitoring & Analytics

• Track IP usage
• Monitor billing cycles
• View usage statistics
• Check remaining quotas

​

Example Commands

​

Check Status

/brightdata check my account status

​

Create Zone

/brightdata create residential zone "data_collection" for US traffic

​

List Zones

/brightdata show all my proxy zones

​

Update Zone

/brightdata update zone "zone_12345abc" to enterprise plan

​

Get Proxy Config

/brightdata show proxy configuration details

​

Monitor Usage

/brightdata check IP usage statistics

​

Zone Types

​

Residential

• Real residential IPs
• High success rates
• Country targeting
• Premium pricing

​

Datacenter

• Fast datacenter IPs
• Cost-effective
• High throughput
• Good for APIs

​

Mobile

• Mobile carrier IPs
• Mobile-specific content
• Carrier targeting
• Premium features

​

Zone Management

​

Creation Options

• name: Zone identifier
• type: residential/datacenter/mobile
• country: Target country
• plan: production/enterprise

​

Configuration Updates

• Change zone names
• Upgrade plans
• Modify settings
• Update targeting

​

Proxy Configuration

​

Connection Strings

• Zone-specific URLs
• Authentication credentials
• Port assignments
• Protocol support

​

Authentication

• Username/password pairs
• Zone-based credentials
• API key generation
• Whitelist management

​

Usage Monitoring

​

IP Statistics

• Total available IPs
• Active IP count
• Usage by zone
• Historical data

​

Billing Information

• Current plan details
• Usage vs. limits
• Estimated charges
• Billing cycle info

​

API Key Management

​

Key Generation

• Zone-specific keys
• Expiration dates
• Named keys
• Access control

​

Key Properties

• key_id: Unique identifier
• key: API access token
• name: Descriptive name
• expires_at: Expiration date

​

Whitelist Management

​

IP Whitelisting

• Add multiple IPs
• Bulk operations
• Description labels
• Status tracking

​

Whitelist Benefits

• Improved security
• Faster authentication
• Reduced blocks
• Better performance

​

Billing & Usage

​

Usage Tracking

• Data transfer (GB)
• Request counts
• Zone-specific usage
• Real-time monitoring

​

Billing Cycles

• Monthly/custom periods
• Usage limits
• Overage charges
• Cost estimates

​

Best Practices

1. Zone Organization

   • Use descriptive names
   • Separate by purpose
   • Monitor usage per zone

2. IP Management

   • Whitelist your IPs
   • Monitor usage patterns
   • Rotate when needed

3. Cost Control

   • Track usage regularly
   • Set appropriate limits
   • Choose right plan types

4. Security

   • Generate zone-specific keys
   • Set key expiration dates
   • Regularly rotate credentials

​

Error Handling

​

Common Issues

• Zone not found errors
• Authentication failures
• Usage limit exceeded
• Invalid configurations

​

Status Codes

• active: Zone operational
• inactive: Zone disabled
• pending: Setup in progress
• error: Configuration issue

​

Tips

• Check status before operations
• Use specific zone IDs for updates
• Monitor billing to avoid overages
• Whitelist your server IPs for better performance
• Generate separate API keys for different applications