Get the complete browser profile configuration

Client version1.8.0 (latest)1.7.0Version overview

GET

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

Return the complete public configuration of the specified profile for the current user and team: browser engine and effective User-Agent, fingerprint, proxy, window, common settings, Cookies, bound account IDs, and extension IDs. The field structure matches the create/edit profile requests, so the configuration can be modified and submitted directly through PUT /browsers/{envId}. Fingerprint components in random mode return only the mode, not internal values generated by the backend. Proxy passwords are masked as ******; the plaintext password must be supplied again when editing the proxy. The response contains Cookies, so the Local API returns Cache-Control: no-store.

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 browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

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 -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890/profile'

fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890/profile", {
  method: "GET",
  headers: {
      "Authorization": "Bearer <TOKEN>"
    },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "GET",
    "headers": {
      "Authorization": "Bearer <TOKEN>"
    }
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890/profile", 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/profile');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
  ],
]);

$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"
)

func main() {
	req, err := http.NewRequest("GET", "http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890/profile", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")

	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 {
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890/profile"))
        .header("Authorization", "Bearer <TOKEN>")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .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/profile"
headers = {
    "Authorization": "Bearer <TOKEN>"
}

response = requests.get(url, headers=headers)
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.

Complete public configuration of the specified browser profile

Body

Response content typeapplication/jsonBrowserProfileDetailSuccessResponse

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": {
    "env_id": "env_01JABCDEF1234567890",
    "env_sn": 0,
    "name": "string",
    "sort": 0,
    "remark": "string",
    "command_line": "string",
    "group": {
      "id": "string",
      "name": "string"
    },
    "status": "active",
    "window": {
      "width": 0,
      "height": 0
    },
    "browser": {
      "kernel_version": "string",
      "system_os": "Windows",
      "system_version": "string",
      "ua_version": "string",
      "user_agent": "string"
    },
    "proxy": {
      "mode": "none"
    },
    "fingerprint": {
      "webrtc": {
        "mode": "real"
      },
      "timezone": {
        "mode": "real"
      },
      "geolocation": {
        "mode": "real"
      },
      "language": {
        "mode": "real"
      },
      "screen": {
        "mode": "real"
      },
      "fonts": {
        "mode": "real"
      },
      "noise": {
        "canvas": true,
        "webgl": true,
        "audio_context": true,
        "client_rects": true
      },
      "webgl": {
        "mode": "real"
      },
      "memory": {
        "mode": "real"
      },
      "cpu": {
        "mode": "real"
      },
      "do_not_track": {
        "mode": "default"
      },
      "port_scan_protection": {
        "mode": "disabled"
      },
      "hardware_acceleration": {
        "mode": "default"
      },
      "battery": {
        "mode": "real"
      },
      "media_devices": {
        "mode": "real"
      }
    },
    "common_settings": {
      "image_size_limit_kb": 0,
      "restore_last_session": true,
      "block_video_autoplay": true,
      "disable_video_preload": true,
      "mute_audio": true,
      "disable_translate_prompt": true,
      "disable_password_save_prompt": true,
      "block_notifications": true,
      "block_clipboard_read": true,
      "stop_open_on_network_error": true,
      "stop_open_on_ip_change": true,
      "stop_open_on_country_change": true,
      "search_engine_preset": "360"
    },
    "cookies": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "random_fp_on_open": true,
    "account_ids": [
      "account_01JABCDEF1234567890"
    ],
    "extension_ids": [
      "extension_01JABCDEF1234567890"
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "last_opened_at": "2024-01-15T09:30:00Z"
  }
}

View all business error codes and HTTP statuses