Skip to content
Local APIProfile recycle bin

List browser profiles in the recycle bin ​

Version overview
GET
/api/v1/recycle-bin

Return a paginated list of profiles in the current team recycle bin, including when each was moved there and when it will be automatically deleted permanently after 30 days. The backend removes expired records before querying.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Query parameters

8
Fields
integer
Page number
Default1
Example1
minimum: 1
integer
Items per page; default: 10, maximum: 100
Default10
Example10
minimum: 1maximum: 100
string
Partial-match filter by browser profile ID
minLength: 1
string
Partial-match filter by browser profile name
minLength: 1
string
Partial-match filter by browser profile notes
minLength: 1
string
Partial-match filter by the user who deleted the profile
minLength: 1
string
Partial-match filter by browser profile owner
minLength: 1
string
Sort field and direction. Supported fields: env_id, env_name, deleted_at. asc means ascending; desc means descending.
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/recycle-bin?page=1&size=10'

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 profiles in the recycle bin

Body

application/jsonRecycleBinListSuccessResponse
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_name": "string",
        "remark": "string",
        "deleted_by": "string",
        "owner": "string",
        "deleted_at": "2024-01-15T09:30:00Z",
        "expires_at": "2024-01-15T09:30:00Z"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0,
    "total_pages": 0
  }
}

View all business error codes and HTTP statuses

ZYBrowser Local API documentation