What can you do with it?

Manage zones, IPs, authentication, and proxy infrastructure through BrightData’s API, enabling operations such as checking status, managing zones, handling proxy configurations, and monitoring usage for web scraping and data collection.

How to use it?

Basic Command Structure

/your-brightdata-connection [action] [required-parameters] [optional-parameters]

Parameters

Required:

  • action - The operation to perform (check-status, get-zone-status, create-zone, update-zone, list-zones, delete-zone, get-ip-usage, get-proxy-config, create-whitelist, get-billing, generate-api-key)

Optional:

  • zone-id - BrightData zone identifier
  • zone-name - Name for the zone
  • zone-type - Type of zone (residential, datacenter, mobile)
  • country - Country code for zone
  • plan - Zone plan (production, enterprise)

Tools

Check Status

Check the status of your BrightData account

Parameters:

  • No additional parameters required

Example:

/your-brightdata-connection
action: check-status

Response:

{
  "status": "active",
  "customer": "hl_6504f1e5",
  "can_make_requests": true,
  "ip": "171.243.58.62,15.158.13.106, 34.96.45.168"
}

Get Zone Status

Check the status of a specific zone

Parameters:

  • zone-id (required) - The zone ID to check

Example:

/your-brightdata-connection
action: get-zone-status
zone-id: zone123

Response:

{
  "status": "active",
  "customer": "hl_6504f1e5",
  "can_make_requests": false,
  "auth_fail_reason": "zone_not_found",
  "ip": "171.243.58.62,15.158.13.106, 34.96.45.168"
}

Create Zone

Create a new zone in BrightData

Parameters:

  • zone-name (required) - Name for the new zone
  • zone-type (required) - Type of zone (residential, datacenter, mobile)
  • country (required) - Country code for the zone
  • plan (required) - Zone plan (production, enterprise)

Example:

/your-brightdata-connection
action: create-zone
zone-name: my_scraping_zone
zone-type: residential
country: us
plan: production

Response:

{
  "id": "zone_12345abc",
  "name": "my_scraping_zone",
  "type": "residential",
  "country": "us",
  "status": "active",
  "created_at": "2023-09-15T14:30:00Z"
}

Update Zone

Update an existing zone’s configuration

Parameters:

  • zone-id (required) - The zone ID to update
  • zone-name (optional) - New name for the zone
  • plan (optional) - New plan for the zone

Example:

/your-brightdata-connection
action: update-zone
zone-id: zone_12345abc
zone-name: updated_zone_name
plan: enterprise

Response:

{
  "id": "zone_12345abc",
  "name": "updated_zone_name",
  "type": "residential",
  "country": "us",
  "plan": "enterprise",
  "status": "active",
  "updated_at": "2023-09-16T10:15:00Z"
}

List Zones

Retrieve a list of all zones

Parameters:

  • No additional parameters required

Example:

/your-brightdata-connection
action: list-zones

Response:

{
  "zones": [
    {
      "id": "zone_12345abc",
      "name": "updated_zone_name",
      "type": "residential",
      "country": "us",
      "status": "active"
    },
    {
      "id": "zone_67890def",
      "name": "data_center_zone",
      "type": "datacenter",
      "country": "uk",
      "status": "active"
    }
  ],
  "total": 2,
  "page": 1,
  "page_size": 20
}

Delete Zone

Delete a zone from your account

Parameters:

  • zone-id (required) - The zone ID to delete

Example:

/your-brightdata-connection
action: delete-zone
zone-id: zone_12345abc

Response:

{
  "success": true,
  "message": "Zone successfully deleted",
  "id": "zone_12345abc"
}

Get IP Usage

Retrieve IP usage statistics

Parameters:

  • No additional parameters required

Example:

/your-brightdata-connection
action: get-ip-usage

Response:

{
  "total_ips": 1500,
  "active_ips": 950,
  "available_ips": 550,
  "usage_by_zone": [
    {
      "zone_id": "zone_12345abc",
      "zone_name": "updated_zone_name",
      "ips_used": 350
    },
    {
      "zone_id": "zone_67890def",
      "zone_name": "data_center_zone",
      "ips_used": 600
    }
  ],
  "last_updated": "2023-09-16T13:45:00Z"
}

Get Proxy Configurations

Retrieve proxy configuration details

Parameters:

  • No additional parameters required

Example:

/your-brightdata-connection
action: get-proxy-config

Response:

{
  "username": "customer-hl_6504f1e5",
  "password": "pwd_123456abcdef",
  "proxy_addresses": {
    "residential": "brd.superproxy.io:22225",
    "datacenter": "brd.superproxy.io:22224",
    "mobile": "brd.superproxy.io:22226"
  },
  "zone_connection_strings": {
    "zone_12345abc": "zone-updated_zone_name:pwd_123456abcdef@brd.superproxy.io:22225",
    "zone_67890def": "zone-data_center_zone:pwd_123456abcdef@brd.superproxy.io:22224"
  }
}

Create IP Whitelist

Add IP addresses to the whitelist

Parameters:

  • ip-addresses (required) - List of IP addresses to whitelist
  • description (optional) - Description for the whitelist entry

Example:

/your-brightdata-connection
action: create-whitelist
ip-addresses: 203.0.113.1, 198.51.100.2, 192.0.2.3
description: Office IP addresses

Response:

{
  "success": true,
  "added": ["203.0.113.1", "198.51.100.2", "192.0.2.3"],
  "already_whitelisted": [],
  "total_whitelisted": 8
}

Get Billing Information

Retrieve current billing information and usage

Parameters:

  • No additional parameters required

Example:

/your-brightdata-connection
action: get-billing

Response:

{
  "current_plan": "enterprise",
  "billing_cycle": {
    "start_date": "2023-09-01T00:00:00Z",
    "end_date": "2023-09-30T23:59:59Z",
    "days_remaining": 14
  },
  "usage": {
    "gb_used": 450.75,
    "gb_included": 1000,
    "requests_made": 3500000,
    "requests_included": 5000000
  },
  "estimated_charges": 2500.00,
  "currency": "USD"
}

Generate Zone API Key

Generate a new API key for a specific zone

Parameters:

  • zone-id (required) - The zone ID to generate a key for
  • key-name (required) - Name for the API key
  • expires-in-days (optional) - Number of days until expiration (default: 90)

Example:

/your-brightdata-connection
action: generate-api-key
zone-id: zone_12345abc
key-name: script_automation_key
expires-in-days: 90

Response:

{
  "key_id": "key_12345abcdef",
  "key": "bd_api_9876543210abcdefghijklmnopqrstuvwxyz",
  "name": "script_automation_key",
  "created_at": "2023-09-16T15:30:00Z",
  "expires_at": "2023-12-15T15:30:00Z",
  "zone_id": "zone_12345abc"
}

Notes

BrightData supports multiple zone types including residential, datacenter, and mobile proxies. Premium operations require Authorization Bearer token and Premium-Id headers. Zone connection strings include credentials for direct proxy usage. IP whitelisting enhances security for proxy access.