Delete a browser profile (move to recycle bin)

Client version1.8.0 (latest)1.7.0Version overview

DELETE

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

Move the specified browser profile for the current user and team to the recycle bin. Running profiles return 40920. The request body is optional. delete_cache defaults to false; if true, the local profile cache is deleted before moving the profile to the recycle bin. To restore or permanently delete it, use the profile recycle bin endpoints or call /browsers/{envId}/permanent.

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

Body parameters

Request content typeapplication/jsonBrowserDeleteRequest

Fields

›boolean

Whether to also delete the local profile cache; defaults to false, matching the disabled-by-default deletion toggle in the client

Defaultfalse

Example

Generated from the schema; not a live response.

{
  "delete_cache": false
}

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

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

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "DELETE",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"delete_cache\": false\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 => 'DELETE',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "delete_cache": false
}',
]);

$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("DELETE", "http://local.zhongyibrowser.com:39025/api/v1/browsers/env_01JABCDEF1234567890", strings.NewReader(`{
  "delete_cache": false
}`))
	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" +
        "  \"delete_cache\": false\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("DELETE", 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  \"delete_cache\": false\n}"

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

The browser profile has been moved to the recycle bin

Body

Response content typeapplication/jsonBrowserDeleteSuccessResponse

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",
    "status": "recycled",
    "delete_cache": true
  }
}

View all business error codes and HTTP statuses