Account management

  • Get total balance through API

    API endpoint: GET /api/customer/balance Sample Response: {"balance":456,"pending_costs":123} balance : the amount of money in your account pending_costs : the amount of money you will be billed for, as of this moment, in the next ...

  • Get Zone info

    API endpoint: GET /api/zone Sample Response: {"ips":"any","password":["PASSWORD"],"plans":[{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shared","ip_alloc_preset":"shared_block","bandwidth":"payperusage"}]}   Shel...

  • Add a Zone

    API endpoint: POST /api/zone POST body : zone [JSON] [Required] name=NAME [string] - Zone name plan [JSON] [Required] type="static|resident|unblocker" [string] 'static' : Datacenter, ISP 'resident' : Residential, Mobile, SE...

  • Remove Zone

    API endpoint: DELETE /api/zone   Shell curl -X DELETE "https://brightdata.com/api/zone" -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d "{\"zone\":\"ZONE\"}" Node.js #!/usr/bin/env node require('request-...

  • Get Zone passwords

    API endpoint: GET /api/zone/passwords Sample Response: {"passwords":["psw1","psw2"]}   Shell curl "https://brightdata.com/api/zone/passwords?zone=ZONE" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('reque...

  • Get Zone permissions

    API endpoint: GET /api/zone/permissions Sample Response: {"perms":["city","google"]}   Shell curl "https://brightdata.com/api/zone/permissions?zone=ZONE" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('req...

  • Get Zone status

    API endpoint: GET /api/zone/status Sample Response: {"status":"active"}   Shell curl "https://brightdata.com/api/zone/status?zone=ZONE" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('request-promise')({ ...

  • Get active Zones

    API endpoint: GET /api/zone/get_active_zones Sample Response: [{"name":"ZONE1","type":"dc"}]   Shell curl "https://brightdata.com/api/zone/get_active_zones" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('...

  • Get Zone Static(Datacenter/ISP) IPs

    API endpoint: GET /api/zone/ips Optional Parameter: ip_per_country=true to get the total amount of IPs per country Sample Response: {"ips":[{"ip":"1.1.1.1","maxmind":"au","ext":{"dbip":"au","ip2location":"au","google":"us"}},{"ip":...

  • Get live status of Static(Datacenter/ISP) Zone and IPs with connectivity problem

    API endpoint: GET /api/zone/ips/unavailable Sample Response: {"zone1":["1.1.1.1","100.1.1.2"],"zone10":["2.1.1.1"]}   Shell curl "https://brightdata.com/api/zone/ips/unavailable" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/...

  • Add Static(Datacenter/ISP) IPs

    API endpoint: POST /api/zone/ips POST body Required : customer=CUSTOMER [string] zone=ZONE [string] count[integer] Optional : country: new IPs' country (e.g. us) country_city: new IPs' city (e.g. us-chicago)   Sample Response...

  • Remove Static(Datacenter/ISP) IPs

    API endpoint: DELETE /api/zone/ips Sample Response:Response will output the IPs removed.{"ips":["ip1","ip2"]}   Shell curl -X DELETE "https://brightdata.com/api/zone/ips" -H "Content-Type: application/json" -H "Authorization: Beare...

  • Remove dedicated residential IPs

    API endpoint: DELETE /api/zone/vips Sample Response:The response will output the dedicated residential IPs removed.["us_209_wa_seattle_0","us_7922_ca_fresno_0"]   Shell curl -X DELETE "https://brightdata.com/api/zone/vips" -H "Cont...

  • Refresh Static(Datacenter/ISP) IPs

    API endpoint: POST /api/zone/ips/refresh POST body Required : zone=ZONE [string] Optional : ips=["ip1","ip2"]: IPs to refresh* Note : If refresh is needed for all allocated IPs, then ips parameter should be omittedSee pricing fo...

  • Refresh dedicated residential IPs

    API endpoint: POST /api/zone/ips/refresh POST body Required : zone=ZONE [string] Optional : vips=["vip1","vip2"]: IPs to refresh* Note : If refresh is needed for all allocated IPs, then vips parameter should be omittedEach dedic...

  • Migrate Static(Datacenter/ISP) IPs between zones

    API endpoint: POST /api/zone/ips/migrate POST body from=ZONE1 Zone which IPs will be migrated from to=ZONE1 Zone to which IPs will be migrated ips=['ip1','ip2'] Array of ips which should be migrated   Sample Response :Response...

  • Switch 100% uptime ON/OFF in a Static zone

    API endpoint: POST /api/zone/switch_100uptime POST body zone=ZONE active=0|1 0: disable '100% uptime | 1: activate '100% uptime   Shell curl "https://brightdata.com/api/zone/switch_100uptime" -H "Content-Type: application/json...

  • Add domain to Zone whitelist/blacklist

    API endpoint: POST /api/zone/domain_perm POST body zone=ZONE type=whitelist|blacklist domain=d1.com d2.com space separated list of domains Sample Response :Response will output domains whitelist and blacklist in the Zone inclu...

  • Remove domain from Zone whitelist/blacklist

    API endpoint: DELETE /api/zone/domain_perm DELETE body zone=ZONE type=whitelist|blacklist domain=d1.com d2.com space separated list of domains Sample Response:Response will output the remaining domains in the specified 'type' ...

  • Turn on/off Zone

    API endpoint: POST /api/zone/change_disable POST body zone=ZONE disable=0|1 to activate the zone the value should be 0, otherwise 1 Sample Response : {"plan":{"start":"2019-07-15T18:08:59.269Z","type":"static","ips_type":"shar...

  • Get account status

    API endpoint: GET /api/status Sample Response: {"status":"active"}   Shell curl "https://brightdata.com/api/status" -H "Authorization: Bearer API_TOKEN" Node.js #!/usr/bin/env node require('request-promise')({ url: 'https://bright...

  • Change account status

    API endpoint: PUT /api/status PUT body status=suspend_manual|active Sample Response : {"status":"suspend_manual"}   Shell curl -X PUT "https://brightdata.com/api/status" -H "Content-Type: application/json" -H "Authorization: B...

  • Get a list of whitelisted IPs for a specific Zone

    API endpoint: GET /api/zone/whitelist Parameter: zones=ZONE - To get a list of whitelisted IPs for all your Zones : zones=* Sample Response: {"ZONE":["127.0.0.1"]} {"ZONE1":["1.1.1.1","2.2.2.2"],"ZONE2":["any"]}   Shell curl "https...

  • Add IP to Zone whitelist

    API endpoint: POST /api/zone/whitelist POST body zone=ZONE - can be skipped to affect all your zones when adding a single IP / list of IP / IP subnet ip - can be in one of the following formats Add a single IP [string] - ip="1.2...

  • Remove IP from Zone whitelist

    API endpoint: DELETE /api/zone/whitelist DELETE body zone=ZONE - can be skipped to affect all your zones ip - can be in one of the following formats Delete a single IP [string] - ip="1.2.1.2" Delete a IP subnet [string] - ip="10...

  • Get a list of blacklisted IPs for a specific Zone

    API endpoint: GET /api/zone/blacklist Parameter: zones=ZONE - To get a list of blacklisted IPs for all your Zones : zones=* Sample Response: {"ZONE":["127.0.0.1"]} {"ZONE1":["127.0.0.1"],"ZONE2":["127.0.0.2"]}   Shell curl "https:/...

  • Add IP to Zone blacklist

    API endpoint: POST /api/zone/blacklist POST body zone=ZONE - can be skipped to affect all your zones ip - can be in one of the following formats Add a single IP [string] - ip="1.2.1.2" Add a IP range [string] - ip="1.2.1.2-1.2.1...

  • Remove IP from Zone blacklist

    API endpoint: DELETE /api/zone/blacklist DELETE body zone=ZONE - can be skipped to affect all your zones ip - can be in one of the following formats Delete a single IP [string] - ip="1.2.1.2" Delete a IP range [string] - ip="1.2...