Replace proxy profile bindings

Client version1.8.0 (latest)1.7.0Version overview

PUT

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/proxies/{proxy_id}/browsers

Replace the complete list of profiles bound to a proxy. Supports custom, api, integ, and syt proxies. Duplicate profile IDs are removed automatically; an empty array unbinds all profiles. The Local API first verifies that the proxy and all profiles belong to the current user and team. If any profile does not exist or is inaccessible, the entire request returns 404 without calling the backend binding endpoint. This operation only updates proxy bindings and profile proxy settings; it does not start or stop browsers.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Path parameters

1

Fields

›stringrequired

Unique proxy ID

Example"proxy_01JABCDEF1234567890"

minLength: 1

Body parameters

requiredRequest content typeapplication/jsonProxyBindBrowsersRequest

Fields

›string[]required

Complete list of profile IDs to bind to this proxy. Duplicate values are removed automatically; an empty array unbinds all profiles.

Each array item:

Unique browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

Example

Generated from the schema; not a live response.

{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers'

fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers", {
  method: "PUT",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "PUT",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}',
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

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

func main() {
	req, err := http.NewRequest("PUT", "http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers", strings.NewReader(`{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}`))
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = "{\n" +
        "  \"env_ids\": [\n" +
        "    \"env_01JABCDEF1234567890\"\n" +
        "  ]\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("PUT", HttpRequest.BodyPublishers.ofString(body))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890/browsers"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Final profile bindings for the proxy

Body

Response content typeapplication/jsonProxyBindBrowsersSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "proxy_id": "proxy_01JABCDEF1234567890",
    "browser_ids": [
      "env_01JABCDEF1234567890"
    ],
    "browser_count": 0
  }
}

View all business error codes and HTTP statuses