Restart a browser profile

Client version1.8.0 (latest)1.7.0Version overview

POST

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/browsers/restart

After validating the current user and team ownership, gracefully close the active browser and start it again. url, window_state, and headless behave as they do in the start endpoint. window_state=last restores the window dimensions from the previous session. Inactive profiles return 40903. In a successful response, reused is always false.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body parameters

requiredRequest content typeapplication/jsonBrowserRestartRequest

Fields

›stringrequired

Unique browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

›string

HTTP(S) URL to open in a new tab after starting or reusing the profile

format: "uri"

›string

Override the startup window dimensions/state in the local client configuration. normal uses the profile window dimensions; last restores the dimensions from the previous session; minimized means minimized; maximized means maximized. Ignored in headless mode.

Enum

›boolean

Explicitly override headless mode. If omitted, the --headless configuration in the profile command_line is used.

Example

Generated from the schema; not a live response.

{
  "env_id": "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 POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_id": "env_01JABCDEF1234567890"
}' 'http://local.zhongyibrowser.com:39025/api/v1/browsers/restart'

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

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "POST",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"env_id\": \"env_01JABCDEF1234567890\"\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/browsers/restart", 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/restart');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "env_id": "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("POST", "http://local.zhongyibrowser.com:39025/api/v1/browsers/restart", strings.NewReader(`{
  "env_id": "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_id\": \"env_01JABCDEF1234567890\"\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/browsers/restart"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("POST", 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/restart"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"env_id\": \"env_01JABCDEF1234567890\"\n}"

response = requests.post(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.

Browser restart result

Body

Response content typeapplication/jsonBrowserRestartSuccessResponse

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",
    "group": {
      "id": "string",
      "name": "string"
    },
    "status": "active",
    "headless": true,
    "ws_endpoint": "string",
    "reused": false
  }
}

View all business error codes and HTTP statuses