Edit a browser profile

PUT

/api/v1/browsers/{envId}

Partially edit a browser profile for the current user and team. Only fields explicitly supplied in the request are updated. Changes can be saved while the profile is running and take effect on its next start. When browser compatibility settings change, the backend regenerates internal UA fields. Unmodified random fingerprint values remain unchanged.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Path parameters

Fields

stringrequired

Unique browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

Body parameters

requiredapplication/jsonBrowserUpdateRequest

Fields

string

New browser profile name

minLength: 1maxLength: 32

object

Browser window dimensions to update

Additional fields are not allowed.

object

Regenerate internal UA fields when browser engine, operating system, or UA compatibility settings change. null restores automatic selection.

Additional fields are not allowed.

string | null

null moves the profile to the current user default group

minLength: 1maxLength: 32

object[] | null

null clears Cookies; omitting the field preserves the current value

maxItems: 500

string | null

null clears the notes

maxLength: 5000

string | null

null clears the startup arguments

maxLength: 5000

object

mode=none removes the proxy; omitting the field preserves the current proxy

string[]

Replace existing account bindings; an empty array clears all bindings

maxItems: 100

Each array item:

Unique account ID

Example"account_01JABCDEF1234567890"

minLength: 1

object[]

Create accounts and add their bindings to the profile

minItems: 1maxItems: 20

string[]

Replace manually bound extensions; an empty array retains only globally enabled extensions

maxItems: 100

Each array item:

Unique extension ID

Example"extension_01JABCDEF1234567890"

minLength: 1

object

Common browser settings to update; omitted child fields retain their current values

Additional fields are not allowed.

object

Browser fingerprint settings to update; omitted child fields retain their current values

Additional fields are not allowed.

boolean

Whether to randomize the fingerprint again whenever the profile is opened; retains the current value if omitted

Generated from the schema; not a live response.

{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}

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 '{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890'

fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890", {
  method: "PUT",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"string\",\n  \"window\": {\n    \"width\": 0,\n    \"height\": 0\n  },\n  \"browser\": {\n    \"kernel_version\": \"string\",\n    \"system_os\": \"Windows\",\n    \"system_version\": \"string\",\n    \"ua_version\": \"string\"\n  },\n  \"group_id\": \"string\"\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  \"name\": \"string\",\n  \"window\": {\n    \"width\": 0,\n    \"height\": 0\n  },\n  \"browser\": {\n    \"kernel_version\": \"string\",\n    \"system_os\": \"Windows\",\n    \"system_version\": \"string\",\n    \"ua_version\": \"string\"\n  },\n  \"group_id\": \"string\"\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890", 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/browsers/env_01JABCDEF1234567890');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}',
]);

$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/browsers/env_01JABCDEF1234567890", strings.NewReader(`{
  "name": "string",
  "window": {
    "width": 0,
    "height": 0
  },
  "browser": {
    "kernel_version": "string",
    "system_os": "Windows",
    "system_version": "string",
    "ua_version": "string"
  },
  "group_id": "string"
}`))
	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" +
        "  \"name\": \"string\",\n" +
        "  \"window\": {\n" +
        "    \"width\": 0,\n" +
        "    \"height\": 0\n" +
        "  },\n" +
        "  \"browser\": {\n" +
        "    \"kernel_version\": \"string\",\n" +
        "    \"system_os\": \"Windows\",\n" +
        "    \"system_version\": \"string\",\n" +
        "    \"ua_version\": \"string\"\n" +
        "  },\n" +
        "  \"group_id\": \"string\"\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890"))
        .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/browsers/env_01JABCDEF1234567890"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"string\",\n  \"window\": {\n    \"width\": 0,\n    \"height\": 0\n  },\n  \"browser\": {\n    \"kernel_version\": \"string\",\n    \"system_os\": \"Windows\",\n    \"system_version\": \"string\",\n    \"ua_version\": \"string\"\n  },\n  \"group_id\": \"string\"\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.

Updated browser profile ID and running status

Body

application/jsonBrowserUpdateSuccessResponse

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.

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "env_id": "env_01JABCDEF1234567890",
    "name": "string",
    "status": "active"
  }
}

View all business error codes and HTTP statuses

Edit a browser profile ​

Request parameters

Request code examples

Responses

Edit a browser profile