You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Removes history information on pages and their attachments based on space keys or the whole Confluence instance.
Removes history for all pages on the space with the given key.
The service starts a long running task that covers all accessible, current pages of the specified spaces. If no spaces are specified, the service will cover all spaces on the Confluence instance.
There are options to remove the history of pages as well as the history of the page attachments.
Parameters
The service provides the following parameters to control the histories to be cleaned.
spaceKeys
The list of comma-separate keys to the space to remove the history of their pages. If not specified, all spaces are traversed.
keepCount
The number of page versions to keep, 1 (default) meaning that only the current version is kept.
Accepted values are larger than zero.
preservePattern
The pattern to match for version comments. Versions that match this pattern are preserver, that is: not removed.
The preserve pattern is applied to all page versions that are taken into consideration. That is the versions saved with the keepCount
are preserved whether they match this pattern or not.
removeAttachments
Controls whether or not the attachments of versions that are not removed should also be cleaned.
If checked previous versions of attachments to pages are also removed.
attachmentKeepCount
The number of attachment versions to keep, 1 (default) meaning that only the current version is kept.
Response
The response on a successful call is 202
with a Location
header information to find the started long running task.
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.