List browser profiles

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

Return a paginated list of browser profiles for the current user and team, including active/inactive status. Profile availability is calculated from the plan quota and the browser engines supported by the current system.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Query parameters

7

Fields

›integer

Page number

Default1

Example1

minimum: 1

›integer

Items per page; default: 10, maximum: 100

Default10

Example10

minimum: 1maximum: 100

›string

Filter by browser profile ID

minLength: 1

›string

Filter by browser profile name

minLength: 1

›string

Filter by browser profile notes

minLength: 1

›string

Filter by group ID

minLength: 1

›string

Filter by browser profile status. Browser profile status on this computer: active means the browser is open; inactive means the browser is not open

Enum

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?page=1&size=10'

fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers?page=1&size=10", {
  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?page=1&size=10", 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?page=1&size=10');
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?page=1&size=10", 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?page=1&size=10"))
        .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?page=1&size=10"
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.

User browser profile list

Body

Response content typeapplication/jsonBrowserListSuccessResponse

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": {
    "items": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "env_sn": "string",
        "env_name": "string",
        "sort": 0,
        "remark": "string",
        "group": {
          "id": "string",
          "name": "string"
        },
        "kernel_version": "string",
        "is_available": true,
        "unavailable_reason": "package_limit",
        "status": "active",
        "headless": true,
        "ws_endpoint": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0,
    "total_pages": 0
  }
}

View all business error codes and HTTP statuses