Clears the trash cans of spaces or the whole Confluence instance.

Name
Clear Trash
Parent
Type
Path
rest/historymgr/1/trash/clear
Method
POST
Since
1.0

Clears the trash cans of the specified spaces. If no space key is provided, the trash cans of all spaces within the Confluence instance are cleared.

The service starts a long running task that covers all accessible, current spaces.

No Undo!

 

There is no undo!

It is strongly recommended to run commands only on backed up instances. Make a backup of your data before starting to work with this API! Consider to run your experiments on a copy of the production data!

Parameters

The service provides the following parameters to control the histories to be cleaned.

spaceKeys

The list of comma-separate keys to the spaces to clear their trash cans. If not specified, all spaces are cleared.

Response

The response on a successful call is 202 with a Location header information to find the started long running task.

 

A location value is a link to the REST service providing access to the long running task.

http://localhost:1990/confluence/rest/api/longtask/6e19ce1e-9671-4953-bd1d-a915a15b1a57

If a space key does not point to a space or a space is not accessible for the user starting the service, this space key is skipped.

The response returns a 500 on any internal error.