• 186
    • 174
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      NOTE: This suggestion is for Confluence Cloud. Using Confluence Server? See the corresponding suggestion.

      Suggestion

      The XML-RPC and SOAP APIs used to have an exportSpace functionality, however they are deprecated since Confluence 5.5. The REST API functionality does not include an option for creating space/site exports. Even if the exported XML is not transferred via the REST interface, the action could trigger the backup of any given space or the instance to the export directory, optionally providing a download link for it

      Workaround
      1. The Confluence CLI provides such functionality, but it is a paid third-party add-on. The above functionality would be important to automate migration/backup tasks for administrators.
      2. Use the atlassian-python-api library, which provides a method called get_space_export in the confluence.py module. This method allows you to trigger space exports through REST API requests. Please note that this library is community-maintained and is not officially supported by Atlassian

            [CONFCLOUD-40457] Add REST API endpoint for generating space exports

            Hi Team, 

            We want to backup the content in all our spaces.
            Currently, there are around 331 spaces in our confluence. 
            My use case is,
            I want to export and download the content in all spaces to my local (Just we do maually) in an automated way.

            Gottemukkula Rajeev added a comment - Hi Team,  We want to backup the content in all our spaces. Currently, there are around 331 spaces in our confluence.  My use case is, I want to export and download the content in all spaces to my local (Just we do maually) in an automated way.

            Avinash Bisht added a comment - https://getsupport.atlassian.com/browse/CHAT-56763

            It would be very helpful for admins to have the ability to automatically backup confluence cloud 

            Syed Ibrahim added a comment - It would be very helpful for admins to have the ability to automatically backup confluence cloud 

            @subramanian M: I have a WIP script to download a space as a workaround if you're willing to try: https://github.com/dernorberto/confluenceDumpWithPython
            The caveat being that it's not updating all the links to the local files yet, only for the attachments/embeds/emoticons so far.

            Norberto Soares added a comment - @subramanian M: I have a WIP script to download a space as a workaround if you're willing to try: https://github.com/dernorberto/confluenceDumpWithPython The caveat being that it's not updating all the links to the local files yet, only for the attachments/embeds/emoticons so far.

            We would like to have regular confluence cloud backup 3 day's once. So an API endpoint is definitely useful

            Subramanian M added a comment - We would like to have regular confluence cloud backup 3 day's once. So an API endpoint is definitely useful

            Glen Byrne added a comment - - edited

            That is full site export functionality that is described in that link Gail. This request (over 7 years old now) is to enable the automation of space exports (by scheduling or via the API, I'll take either at this stage).

            It is not even clear that a full site back up is of any use at all anyhow, if you use Jira + Confluence cloud, which we do (as opposed to Confluence server, where it might be). As I understand it, to get anything from a full site Confluence back up from Confluence cloud, you would need to implement an entire Confluence server site to allow for the restore, take what you need from the restored server site, and then reimport that into Confluence cloud. That's a hell of a lot of effort if you're looking for a few accidentally deleted pages (if those deleted pages don't still happen to live in the trash bucket for the space).

            The ability to export spaces would mean you could easily restore an entire space up to Confluence cloud, if you needed to (quickly). It would also mean you could do useful things like, for example, check if a space had been updated since the last export, and skip exporting the space if it hasn't changed.

            The automation functionality is useful sure; but not for the use case that this request is looking to fulfil.

             

            [[ UPDATE: Actually, apologies! I've just realised that you can create the automation rule to run over a single site, the full site, or multiple selected sites. I'm not sure whether that means you get a full site content export - for a single or multiple sites - or the type of export which allows re-importation to confluence cloud. I'd have to test that in more detail, but it may be more useful than I originally thought.]]

             

            Glen Byrne added a comment - - edited That is full site export functionality that is described in that link Gail. This request (over 7 years old now) is to enable the automation of space exports (by scheduling or via the API, I'll take either at this stage). It is not even clear that a full site back up is of any use at all anyhow, if you use Jira + Confluence cloud, which we do (as opposed to Confluence server, where it might be). As I understand it, to get anything from a full site Confluence back up from Confluence cloud, you would need to implement an entire Confluence server site to allow for the restore, take what you need from the restored server site, and then reimport that into Confluence cloud. That's a hell of a lot of effort if you're looking for a few accidentally deleted pages (if those deleted pages don't still happen to live in the trash bucket for the space). The ability to export spaces would mean you could easily restore an entire space up to Confluence cloud, if you needed to (quickly). It would also mean you could do useful things like, for example, check if a space had been updated since the last export, and skip exporting the space if it hasn't changed. The automation functionality is useful sure; but not for the use case that this request is looking to fulfil.   [[ UPDATE: Actually, apologies! I've just realised that you can create the automation rule to run over a single site, the full site, or multiple selected sites. I'm not sure whether that means you get a full site content export - for a single or multiple sites - or the type of export which allows re-importation to confluence cloud. I'd have to test that in more detail, but it may be more useful than I originally thought.]]  

            Gail added a comment -

            I am using this process for both confluence and jira, and it works.   I just need to figure out how to make it download the backup file.   https://community.atlassian.com/t5/Jira-articles/Automate-online-site-backups-for-Jira-and-Confluence-without/ba-p/1271317 

            Gail added a comment - I am using this process for both confluence and jira, and it works.   I just need to figure out how to make it download the backup file.   https://community.atlassian.com/t5/Jira-articles/Automate-online-site-backups-for-Jira-and-Confluence-without/ba-p/1271317  

            We really need this function. We can not do DR due to Confluence Cloud site backup and restore not working. EAP backup/restore not function for 1 particular space.

            Frank Liang added a comment - We really need this function. We can not do DR due to Confluence Cloud site backup and restore not working. EAP backup/restore not function for 1 particular space.

            This feature was first identified as missing back in 2016.... I would have thought enabling one's customers to make automated, off-site backups would have been higher up on the developer priority list. Especially given Atlassian's recent large-scale outages. 

            Jon Hinton added a comment - This feature was first identified as missing back in 2016.... I would have thought enabling one's customers to make automated, off-site backups would have been higher up on the developer priority list. Especially given Atlassian's recent large-scale outages. 

            Joe Miao added a comment -

            We are a finance shop and are required by regulators to backup (WORM) some pages(and versions) in Confluence on a daily basis. We would like to automate this flow. So an API endpoint is definitely useful. 

            Joe Miao added a comment - We are a finance shop and are required by regulators to backup (WORM) some pages(and versions) in Confluence on a daily basis. We would like to automate this flow. So an API endpoint is definitely useful. 

            C. Dicker added a comment -

            We need a way to automate generation+download of both, the full backup for recovery and also the HTML-export!

            Workaround for full backup with jira-confluence-cloud-backup/backup-confluence-api-token.ps1 at master · bluesman80/jira-confluence-cloud-backup · GitHub

            But yet, we haven't fount a script for automating the HTML-export.

            C. Dicker added a comment - We need a way to automate generation+download of both, the full backup for recovery and also the HTML-export! Workaround for full backup with jira-confluence-cloud-backup/backup-confluence-api-token.ps1 at master · bluesman80/jira-confluence-cloud-backup · GitHub But yet, we haven't fount a script for automating the HTML-export.

            Nicholas Andre added a comment - - edited

            FYI to the other poor saps in the same situation looking for workarounds to this gap in Confluence's cloud system:

            In lieu of having a dedicated backup option, I implemented a quick and dirty custom backup script in Python with an eye towards enabling disaster recovery in case there was an incident. If you run it on AWS will give you exports of every single page on confluence to S3. Each file will be written to

            {space_id}.{page_id}.{version_id}
            

            and it will continue to add any new versions that are marked "current" in the API.

            See the README on github. Released it under the MIT license.

            FYI the format of the export is controlled with the '?expand=childTypes.all,body.storage' parameter. I believe there's a body.display or something that will give HTML more conducive to rendering in a browser. You could then use some more python to export things to an S3 bucket or something just be aware of private content since this doesn't replicate any permissions settings.

            Nicholas Andre added a comment - - edited FYI to the other poor saps in the same situation looking for workarounds to this gap in Confluence's cloud system: In lieu of having a dedicated backup option, I implemented a quick and dirty custom backup script in Python with an eye towards enabling disaster recovery in case there was an incident. If you run it on AWS will give you exports of every single page on confluence to S3. Each file will be written to {space_id}.{page_id}.{version_id} and it will continue to add any new versions that are marked "current" in the API. See the README on github. Released it under the MIT license. FYI the format of the export is controlled with the '?expand=childTypes.all,body.storage' parameter. I believe there's a body.display or something that will give HTML more conducive to rendering in a browser. You could then use some more python to export things to an S3 bucket or something just be aware of private content since this doesn't replicate any permissions settings.

            It's not just about creating backups. In the unlikely scenario that Confluence Cloud is down, clients will need to be able to restore the backup so that they can view their pages. I suspect a read-only set of static web pages would be a reasonable temporary workaround for most clients until the issue is resolved. I see there is an export to html option, but that didn't work me when I tried to do it manually. https://confluence.atlassian.com/doc/export-content-to-word-pdf-html-and-xml-139475.html

            Taiji Okada added a comment - It's not just about creating backups. In the unlikely scenario that Confluence Cloud is down, clients will need to be able to restore the backup so that they can view their pages. I suspect a read-only set of static web pages would be a reasonable temporary workaround for most clients until the issue is resolved. I see there is an export to html option, but that didn't work me when I tried to do it manually. https://confluence.atlassian.com/doc/export-content-to-word-pdf-html-and-xml-139475.html

            We were without Confluence for 9 days, working from memory was quite difficult, we wrote it down so we wouldn't have to remember! Automated space exports are a must have feature!

            Paul Julier added a comment - We were without Confluence for 9 days, working from memory was quite difficult, we wrote it down so we wouldn't have to remember! Automated space exports are a must have feature!

            Considering that every department in my company relies on the use of run books for day to day operations, and considering that our Confluence has been down for 8 days and that we're now being told that we could continue to be working in the dark for another two weeks, an automated export and offsite backup is imperative for our business continuity moving forward.

            inger.klekacz added a comment - Considering that every department in my company relies on the use of run books for day to day operations, and considering that our Confluence has been down for 8 days and that we're now being told that we could continue to be working in the dark for another two weeks, an automated export and offsite backup is imperative for our business continuity moving forward.

            We were hit by this latest incident. Our Confluence and Jira site were down for a week only had a site backup wich was 2Month old. It is crucial to hav an automated backup!

            Martin Bachmann added a comment - We were hit by this latest incident. Our Confluence and Jira site were down for a week only had a site backup wich was 2Month old. It is crucial to hav an automated backup!

            "When using Confluence AND Jira there is no option for a Confluence Site import. A space by space import is then the only option", and an automated space by space option is not available? This is troublesome!

            Mark de Bont added a comment - "When using Confluence AND Jira there is no option for a Confluence Site import. A space by space import is then the only option", and an automated space by space option is not available? This is troublesome!

            kt.bel added a comment -

            Also, especially with the recent incident that seems to be still impacting some Confluence Customers (at least when I look at Atlassian Status) - having this sort of backup seems essential, especially for Confluence Cloud customers that have Jira.

            kt.bel added a comment - Also, especially with the recent incident that seems to be still impacting some Confluence Customers (at least when I look at Atlassian Status) - having this sort of backup seems essential, especially for Confluence Cloud customers that have Jira.

            +1

            Heike Fischer added a comment - +1

            As with other users we put a lot of time and effort into our confluence space and would really appreciate an easy way to backup full spaces to a separate location.  Ideally in such a way that it could be re-imported easily in the event of a serious mistake/data loss.

            Matt Dumont added a comment - As with other users we put a lot of time and effort into our confluence space and would really appreciate an easy way to backup full spaces to a separate location.  Ideally in such a way that it could be re-imported easily in the event of a serious mistake/data loss.

            Seidl A. added a comment -

            +1

            Seidl A. added a comment - +1

            +1

            Pawan Shrestha added a comment - +1

            Nicholas Andre added a comment - - edited

            This is very important to us. There is no way to backup spaces automatically in a way that can be re-imported in case of accidental delete or other issue, and support informed us that they're unable to restore backups if a space is deleted on the server version. The only workaround is to manually export individual pages, which we are doing. But this would be far easier and provide for an easy restore method.

            The existing path https://example.atlassian.net/wiki/spaces/doexportspace.action?key=KEY just needs to be exposed through API and OAuth. An asynchronous method is just fine.

            Nicholas Andre added a comment - - edited This is very important to us. There is no way to backup spaces automatically in a way that can be re-imported in case of accidental delete or other issue, and support informed us that they're unable to restore backups if a space is deleted on the server version. The only workaround is to manually export individual pages, which we are doing. But this would be far easier and provide for an easy restore method. The existing path https://example.atlassian.net/wiki/spaces/doexportspace.action?key=KEY  just needs to be exposed through API and OAuth. An asynchronous method is just fine.

            Jason Gao added a comment -

            +1

            Jason Gao added a comment - +1

            +1

            +1

            Andreas Eising added a comment - +1

            +2000

            Suresh Venkat added a comment - +2000

            +1

            +1 

            Syed Hussain added a comment - +1 

            +1

            Sergey Serikov added a comment - +1

            +1

            Luke Stern added a comment - +1

            +1

            Andy Zhou added a comment -

            +1

            Andy Zhou added a comment - +1

            +1

            Rahul Prasad added a comment - +1

            何兆阳 added a comment -

            +1 

            何兆阳 added a comment - +1 

            +1 

            Dario Bednarski added a comment - +1 

            JAGDISH HIRAY added a comment - - edited

            +1 Agree this is highly desire feature 

            JAGDISH HIRAY added a comment - - edited +1 Agree this is highly desire feature 

            +1 we would like to automate 'export page as pdf'

            Łukasz Kubisiak added a comment - +1 we would like to automate 'export page as pdf'

            Yes please ! +100

            fthery perso added a comment - Yes please ! +100

            +1

            Moritz added a comment -

            This is also of interest to us–we are currently limited by this missing feature.

            Moritz added a comment - This is also of interest to us–we are currently limited by this missing feature.

            Felix Mühlbauer added a comment - - edited

            +1

            We want to automate document processing especially for document validation, export into other formats and backup.

             

            Please rate this very missing feature higher.

            Felix Mühlbauer added a comment - - edited +1 We want to automate document processing especially for document validation, export into other formats and backup.   Please rate this very missing feature higher.

            Sly321 added a comment -

            +1 Huge need for this

            Sly321 added a comment - +1 Huge need for this

            Boris MBOUMEHANG added a comment - - edited

            +1 This functionnality would be really appreciated in our team, as we really depend on the exports of pages to the HTML format, and we would like to automate this exports to same time. 

            In addition, when I use the graphical UI to export pages to HTML, I face this bug when the page contains excerpt and multiexcerpt macros. 

            Boris MBOUMEHANG added a comment - - edited +1 This functionnality would be really appreciated in our team, as we really depend on the exports of pages to the HTML format, and we would like to automate this exports to same time.  In addition, when I use the graphical UI to export pages to HTML, I face  this bug when the page contains excerpt and multiexcerpt macros. 

            +1 Would need this to automate documentation generation. 

            Dominic Fournier added a comment - +1 Would need this to automate documentation generation. 

            Customer feedback:

            This will be really useful if we get to a customer site where we have no connectivity and need to use the documentation without the use of internet locally from a datacenter floor.

            Ramona Scripcaru added a comment - Customer feedback: This will be really useful if we get to a customer site where we have no connectivity and need to use the documentation without the use of internet locally from a datacenter floor.

            +1 for this issue

            Iain MacLeod added a comment - +1 for this issue

            +1

            Possibility for automated scheduled backups using alternate channels is a must.

            Marc Andersen added a comment - +1 Possibility for automated scheduled backups using alternate channels is a must.

            We have use cases where we need to create data dumps of our product source code and documentation for escrow. We have automated other parts of the escrow data file creation, but cannot automatically get our documentation that is in Confluence. What we need is a way to call the Confluence REST API from a script (bash or Ansible) to export an entire Confluence space. We need to deliver the escrow package quite often and don't want to do it manually when it would be trivial to automate.

            Please add export space function to the Confluence REST API.

            Deleted Account (Inactive) added a comment - We have use cases where we need to create data dumps of our product source code and documentation for escrow. We have automated other parts of the escrow data file creation, but cannot automatically get our documentation that is in Confluence. What we need is a way to call the Confluence REST API from a script (bash or Ansible) to export an entire Confluence space. We need to deliver the escrow package quite often and don't want to do it manually when it would be trivial to automate. Please add export space function to the Confluence REST API.

            Yes, that would help here too.

            Sebastien Ribiere added a comment - Yes, that would help here too.

            Rob Kooper added a comment -

            I would also like a REST API to create a full backup of the server.

            Rob Kooper added a comment - I would also like a REST API to create a full backup of the server.

              Unassigned Unassigned
              pkoczan Peter Koczan (Inactive)
              Votes:
              416 Vote for this issue
              Watchers:
              249 Start watching this issue

                Created:
                Updated: