Skip to content
Local APIProfile recycle bin

Permanently delete browser profiles from the recycle bin ​

Version overview
DELETE
/api/v1/recycle-bin

Permanently delete profiles from the current team recycle bin in a batch. After all IDs pass validation, safely clear the local profile cache before deleting backend records. Duplicate IDs are removed automatically. No backend deletion is requested if the cache is in use or the cleanup service is busy.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body parameters

requiredapplication/jsonRecycleBinMutationRequest
Fields
string[]required
Profile IDs in the recycle bin. Duplicate values are removed automatically. Maximum: 100.
minItems: 1maxItems: 100
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 DELETE -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/recycle-bin'

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.

Permanent deletion result

Body

application/jsonRecycleBinDeleteSuccessResponse
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": "deleted",
    "env_ids": [
      "env_01JABCDEF1234567890"
    ],
    "count": 0
  }
}

View all business error codes and HTTP statuses

ZYBrowser Local API documentation