Restore browser profiles from the recycle bin

Client version1.8.0 (latest)1.7.0Version overview

POST

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/recycle-bin/restore

Restore profiles from the current team recycle bin in a batch. Duplicate IDs are removed automatically. The backend is called only after all IDs pass validation. If restoring the profiles would exceed the plan quota, the endpoint returns 40915. This operation preserves the local profile cache.

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/jsonRecycleBinMutationRequest

Fields

›string[]required

Profile IDs in the recycle bin. Duplicate values are removed automatically. Maximum: 100.

minItems: 1maxItems: 100

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 POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/recycle-bin/restore'

fetch("http://local.zhongyibrowser.com:39025/api/v1/recycle-bin/restore", {
  method: "POST",
  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": "POST",
    "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/recycle-bin/restore", 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/recycle-bin/restore');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  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("POST", "http://local.zhongyibrowser.com:39025/api/v1/recycle-bin/restore", 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/recycle-bin/restore"))
        .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/recycle-bin/restore"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\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 profile restoration result

Body

Response content typeapplication/jsonRecycleBinRestoreSuccessResponse

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": {
    "status": "restored",
    "env_ids": [
      "env_01JABCDEF1234567890"
    ],
    "count": 0
  }
}

View all business error codes and HTTP statuses