Archive or Retire a Page
A 5-step recipe with Confluence. We can help you get access.
Recipe · 5 steps
Archive or Retire a Page
with Confluence
Works with AI assistants
Archive a Confluence page, optionally trashing or permanently purging it.
- Read the page to capture its title, space, body, and the current version that the archive write must supersede.
- List the page's children before retiring it. Retiring a parent strands whatever hangs beneath it, so this is the check that should stop a careless purge.
- Set the page's status to archived, which removes it from circulation while keeping it and its history addressable and restorable.
- Move the archived page to the trash, where Confluence retains it and an administrator can still restore it.
- Permanently delete the page. This is irreversible and is only reached when the caller explicitly asked to purge rather than archive or trash.
What you'll need to have ready
- pageId: The id of the page to retire.
- newVersionNumber: The version number to write when archiving, which Confluence requires to be the current version plus one. Arazzo runtime expressions have no arithmetic, so the
- retireAction: One of "archive" to stop at archived, "trash" to move the page to the recycle bin where it can be restored, or "purge" to delete it permanently.
- versionMessage: Changelog message explaining the retirement, recorded on the new version.
For your developer
Arazzo workflow confluence:retire-page, 5 operations: getPageById → getChildPages → updatePage → deletePage → deletePage. Specs on APIs.io.