Back up a Space or multiple Spaces

You can export a single space or multiple spaces to an XML backup in the Confluence administration console.

Multi-space backup is helpful when you want to export a large site in smaller batches or generate a backup based on a team, project, or topic.

You'll need System Administrator permissions to do this.

A single space XML backup can also be generated by Space Admins in Space tools.


Good to know:

  • You can't restore a multi-space XML backup into an earlier version of Confluence.

  • You can’t restore a multi-space XML backup to Confluence Cloud either. Use the Confluence Cloud Migration Assistant app to do this. This is pre-installed with your Confluence installation.

What’s included in a space backup (export)?

A space backup includes, but is not limited to:

  • pages
  • blogs
  • comments
  • attachments
  • drafts

Basically, it’s everything in your space. 

Create a single or multi-space backup (export)

To create an XML backup of one or more spaces:

  1. Go to Administration  > General Configuration > Backup and restore
  2. Select Back up site or spaces
  3. In the Create a backup screen:
    1. Select Spaces
    2. Select the spaces you want to include in your XML export file. You can type the name of a space, or select recent spaces from the dropdown menu.
    3. Give your XML export a file name prefix. Confluence will add a time stamp and unique identifier to the end of this file name. If this field is left blank, the file will be assigned a default prefix and time stamp, for example, for single spaces Confluence-space-export-<SPACE KEY>-2015-04-14-11-07-36-639.xml.zip or for multi-space backups, Confluence-space-export-<NUM SPACES>-spaces-2015-04-14-11-07-36-639.xml.zip
    4. Select Save permanently if you want your file to remain in the <confluence-home>/restore/space folder. Otherwise, the backup will be deleted in 72 hours by default to maintain storage capacity. You can change the storage time by configuring the system property confluence.backuprestore.backup.ttl-in-hours. See Configuring System Properties to learn how.
  4. Select Back up
  5. You will receive a confirmation message, select Back up now to start the task

This process can take some time if you have many large spaces selected.

Retrieve the space backup

Method 1

Once the back up is complete, you can download the XML backup zip file by selecting the file name. This download link will remain active for 72 hours, unless you have chosen to save permanently.

Method 2

Confluence will create the backup as a zipped XML file in your <home-directory>/restore/space folder, where <home directory> is shared-home-directory for Data Center, and home-directory for Server. See Confluence Home and other important directories for more information.

You'll need access to the Confluence server in order to retrieve the file this way.

Restore (import) the space backup

There are some restrictions on which Confluence versions you will be able to import this file into. The most important is that you can't import into an earlier version of Confluence or to Confluence Cloud. See Restore a Space or multiple Spaces for more information and troubleshooting tips. 

Last modified on May 25, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.