Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourYellow
titleGET
http://localhost:8090/rest/purgepageversions/1.0/utility/list/page/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

    versionType

    attachment

  • page

Info

Version 2 (Latest)

Status
colourYellow
titleDELETEGET
http://localhost:8090/rest/purgepageversions/1.0/utility/v2list/purge/pageblogpost/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

  • daysKeep → Latest number of the version to retain. (default: 365 days)

  • authorFilter → Purge only specific Confluence user versions

Status
colourYellow
titleDELETEGET
http://localhost:8090/rest/purgepageversions/1.0/utility/v2list/purge/attachment/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

  • daysKeep → Latest number of the version to retain. (default: 365 days)

  • authorFilter → Purge only specific Confluence user versions

  • isBlogPost

    • false

    • true

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/spacepage/version/summary

Required permission: Remove
Query Parameters:

  • spaceKey pageId - Confluence Space KeyPage ID

  • versionTypeisBlogPost

    • attachmentfalse

    • pagetrue

  • daysKeep versionsKeep Latest Minimum latest number of the version to retain. (defaultDefault: 365 days100).lastDays → Pages Updated or Created Max

  • last daysKeep → Delete versions older than this number of the days to process. (defaultDefault: 1 365 days).

  • pageLimit → Max number of the pages to process. (default: 1)

  • authorFilter → authorName → (Optional) Purge only specific comma separated Confluence user versionsnames.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/all/spacesattachment/version/summary

Required permission: Remove
Query Parameters:

  • versionType

    • attachment

    • page

  • daysKeep → Latest pageId - Confluence Page ID

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (defaultDefault: 365 days100).lastDays → Pages Updated or Created Max

  • last daysKeep → Delete versions older than this number of the days to process. (defaultDefault: 1 365 days).

  • pageLimit → Max number of the pages to process. (default: 1)

  • authorFilter → authorName → (Optional) Purge only specific Confluence user versions

Info

Version 1

Status
colourYellow
titleDELETE

...

  • .

...

Query Parameters:

  • pageId - Confluence Page ID

  • versionsKeep → Latest number of the version to retain

  • authorFilter →

  • fileName → (Optional) Purge only specific Confluence user versions

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v1/purge/attachment/version/summary

Query Parameters:

  • pageId - Confluence Page ID

  • versionsKeep → Latest number of the version to retain

  • fileNameFilter → Purge only specific Confluence Attachment versionsattachment file name.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v1v2/purge/space/version/summary

Required permission: Remove
Query Parameters:

  • spaceKey - Confluence Space Key

  • versionTypepurgeType

    • attachmentpageattachment

    • page

    • blogpost

    • blogpostattachment

    • trash

  • versionsKeep → Latest Minimum latest number of the version to retain

  • lastDays → Pages Updated or Created Max last number of the days to process. (default: 1 days)

  • pageLimit → Max number of the . (Default: 100).

  • daysKeep → Delete versions older than this number of days. (Default: 365 days).

  • pageLimit → Maximum number of the latest updated or created pages to process. (defaultDefault: 1).

  • authorFilter authorName (Optional) Purge only specific comma separated Confluence user versionsnames.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v1v2/purge/all/spaces/version/summary

Required permission: Confluence admin
Query Parameters:

  • versionTypepurgeType

    • attachmentpageattachment

    • page

    • blogpost

    • blogpostattachment

    • trash

  • versionsKeep → Latest Minimum latest number of the version to retain. (Default: 100).lastDays

  • → Pages Updated or Created Max last daysKeep → Delete versions older than this number of the days to process. (defaultDefault: 1 365 days).

  • pageLimit → Max Maximum number of the latest updated or created pages to process. (defaultDefault: 1).

  • authorFilter authorName (Optional) Purge only specific Confluence user versions.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

Info

Legacy (Deprecated)

  • These endpoints processes all the pages (including pages in trash) in space.

  • Consumes more CPU if more than 25K pages.

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v2v1/purge/space/version/legacysummary

Required permission: Remove
Query Parameters:

  • spaceKey - Confluence Space Key

  • versionTypepurgeType

    • attachment

    • page

    daysKeep → Latest
  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the days version to retain. (Default: 100).

  • daysKeep → Delete versions older than this number of days. (defaultDefault: 365 days).

  • authorFilter authorName (Optional) Purge only specific Confluence user versions.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

  • To purge trash attachments

    • trashLimit → default 1000.

    • includeTrash

      • false

      • true

Status
colourYellow
titleDELETE
http://localhost:8090/rest/purgepageversions/1.0/utility/v2v1/purge/all/spaces/version/legacysummary

Required permission: Confluence admin
Query Parameters:

  • versionTypepurgeType

    • attachment

    • page

  • daysKeep → Latest isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the days version to retainauthorFilter → . (Default: 100).

  • daysKeep → Delete versions older than this number of days. (Default: 365 days).

  • authorName → (Optional) Purge only specific Confluence user versions.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

  • To purge trash attachments

    • trashLimit → default 1000.

    • includeTrash

      • false

      • true