Purge Versions REST API

Owned by ILA eSolution
Last updated: Apr 19, 2021
2 min read

GET http://localhost:8090/rest/purgepageversions/1.0/utility/list/page/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

GET http://localhost:8090/rest/purgepageversions/1.0/utility/list/blogpost/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

GET http://localhost:8090/rest/purgepageversions/1.0/utility/list/attachment/version/summary

Required permission: View
Query Parameters:

  • pageId - Confluence Page ID

  • isBlogPost

    • false

    • true

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/page/version/summary

Required permission: Remove
Query Parameters:

  • pageId - Confluence Page ID

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (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

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/attachment/version/summary

Required permission: Remove
Query Parameters:

  • pageId - Confluence Page ID

  • isBlogPost

    • false

    • true

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

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

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

  • fileName → (Optional) Purge only specific Confluence attachment file name.

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/space/version/summary

Required permission: Remove
Query Parameters:

  • spaceKey - Confluence Space Key

  • purgeType

    • attachment

    • page (Default)

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (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. (Default: 1).

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

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

  • includeTrash

    • false

    • true

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v2/purge/all/spaces/version/summary

Required permission: Confluence admin
Query Parameters:

  • purgeType

    • attachment

    • page (Default)

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (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. (Default: 1).

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

  • skipCommented

    • false

    • true

  • dryRun

    • false

    • true

  • includeTrash

    • false

    • true

 

Legacy

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

  • Consumes more CPU if more than 25K pages.

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v1/purge/space/version/summary

Required permission: Remove
Query Parameters:

  • spaceKey - Confluence Space Key

  • purgeType

    • attachment

    • page

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (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

DELETE http://localhost:8090/rest/purgepageversions/1.0/utility/v1/purge/all/spaces/version/summary

Required permission: Confluence admin
Query Parameters:

  • purgeType

    • attachment

    • page

  • isBlogPost

    • false

    • true

  • versionsKeep → Minimum latest number of the version to retain. (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