Recycle Bin

Recycle Bin#

The Recycle Bin REST API provides endpoints to interact with the Plone Recycle Bin functionality.

List recycle bin contents#

To list all items in the recycle bin, send a GET request to the @recyclebin endpoint:

GET /@recyclebin HTTP/1.1
Accept: application/json

Response:

{
  "@id": "http://localhost:8080/Plone/@recyclebin",
  "items": [
    {
      "@id": "http://localhost:8080/Plone/@recyclebin/6d6d626f-8c85-4f22-8747-adb979bbe3b1",
      "id": "document-1",
      "title": "My Document",
      "type": "Document",
      "path": "/Plone/folder/document-1",
      "parent_path": "/Plone/folder",
      "deletion_date": "2025-04-27T10:30:45.123456",
      "size": 1024,
      "recycle_id": "6d6d626f-8c85-4f22-8747-adb979bbe3b1",
      "actions": {
        "restore": "http://localhost:8080/Plone/@recyclebin-restore",
        "purge": "http://localhost:8080/Plone/@recyclebin-purge"
      }
    }
  ],
  "items_total": 1
}

Restore an item from the recycle bin#

To restore an item from the recycle bin, send a POST request to the @recyclebin-restore endpoint:

POST /@recyclebin-restore HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "item_id": "6d6d626f-8c85-4f22-8747-adb979bbe3b1"
}

You can optionally specify a target path to restore to:

{
  "item_id": "6d6d626f-8c85-4f22-8747-adb979bbe3b1",
  "target_path": "/Plone/another-folder"
}

Response:

{
  "status": "success",
  "message": "Item document-1 restored successfully",
  "restored_item": {
    "@id": "http://localhost:8080/Plone/document-1",
    "id": "document-1",
    "title": "My Document",
    "type": "Document"
  }
}

Purge an item from the recycle bin#

To permanently delete an item from the recycle bin, send a POST request to the @recyclebin-purge endpoint:

POST /@recyclebin-purge HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "item_id": "6d6d626f-8c85-4f22-8747-adb979bbe3b1"
}

Response:

{
  "status": "success",
  "message": "Item document-1 purged successfully"
}

Purge all items from the recycle bin#

To purge all items from the recycle bin:

POST /@recyclebin-purge HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "purge_all": true
}

Response:

{
  "status": "success",
  "purged_count": 5,
  "message": "Purged 5 items from recycle bin"
}

Purge expired items from the recycle bin#

To purge only expired items (based on the retention period):

POST /@recyclebin-purge HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "purge_expired": true
}

Response:

{
  "status": "success",
  "purged_count": 2,
  "message": "Purged 2 expired items from recycle bin"
}
Contents