Add zone password

Use the Bright Data Account Management API to add Zone Password. POST /zone/add_password returns 200 OK with zone or account configuration data as JSON.

POST /zone/add_password

Add Zone Password

cURL

curl --request POST \
  --url https://api.brightdata.com/zone/add_password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "zone": "my_zone",
  "password": [
    "123@Abc",
    "456$Abc"
  ]
}
'

import requests

url = "https://api.brightdata.com/zone/add_password"

payload = {
    "zone": "my_zone",
    "password": ["123@Abc", "456$Abc"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({zone: 'my_zone', password: ['123@Abc', '456$Abc']})
};

fetch('https://api.brightdata.com/zone/add_password', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.brightdata.com/zone/add_password",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'zone' => 'my_zone',
    'password' => [
        '123@Abc',
        '456$Abc'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brightdata.com/zone/add_password"

	payload := strings.NewReader("{\n  \"zone\": \"my_zone\",\n  \"password\": [\n    \"123@Abc\",\n    \"456$Abc\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.brightdata.com/zone/add_password")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"zone\": \"my_zone\",\n  \"password\": [\n    \"123@Abc\",\n    \"456$Abc\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.brightdata.com/zone/add_password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"zone\": \"my_zone\",\n  \"password\": [\n    \"123@Abc\",\n    \"456$Abc\"\n  ]\n}"

response = http.request(request)
puts response.read_body

Only users with Admin or Ops roles can perform this action.

To add multiple passwords in a single request, pass an array of strings to the password field.

Authorizations

Authorization · string · header · required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
2. Include the API Key in the Authorization header of your requests
3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Body

application/json

zone · string · required

The name of the zone to add the password to.

password · string[] · required

The password(s) to add. Pass a single string or an array of strings to add multiple passwords.

Response

200

OK