Details
-
Suggestion
-
Status: Gathering Interest (View Workflow)
-
Resolution: Unresolved
-
None
-
398
-
30
-
Description
NOTE: This suggestion is for Confluence Server. Using Confluence Cloud? See the corresponding suggestion.
Suggestion
The deprecated 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
- 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.
- Although deprecated, you may still use the RPC-API to export the entire Space – see the examples below.
Export a Space to XML.
USRNAME=admin USRPWD=password CONFBASEURL=http://127.0.0.1:8090/confluence SPACE_KEY=SPACEKEY curl -s \ --user $USRNAME:$USRPWD \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -X POST \ -d '{ "jsonrpc" : "2.0", "method" : "exportSpace", "params" : ["'${SPACE_KEY}'", "TYPE_XML", "true"], "id": 7 }' \ ${CONFBASEURL}'/rpc/json-rpc/confluenceservice-v2?os_authType=basic'
Export a Space to HTML.
USRNAME=admin USRPWD=password CONFBASEURL=http://127.0.0.1:8090/confluence SPACE_KEY=SPACEKEY curl -s \ --user $USRNAME:$USRPWD \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -X POST \ -d '{ "jsonrpc" : "2.0", "method" : "exportSpace", "params" : ["'${SPACE_KEY}'", "TYPE_HTML", "true"], "id": 7 }' \ ${CONFBASEURL}'/rpc/json-rpc/confluenceservice-v2?os_authType=basic'
Export a Space to PDF.
USRNAME=admin USRPWD=password CONFBASEURL=http://127.0.0.1:8090/confluence SPACE_KEY=SPACEKEY curl -s \ --user $USRNAME:$USRPWD \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -X POST \ -d '{ "jsonrpc" : "2.0", "method" : "exportSpace", "params" : ["'${SPACE_KEY}'"], "id": 7 }' \ ${CONFBASEURL}'/rpc/json-rpc/pdfexport?os_authType=basic'
Space import
For possible workarounds on importing spaces, please also check this KB article: Confluence Space Import Via Scripting Tools
Attachments
Issue Links
- is duplicated by
-
CONFSERVER-55823 Export Space content using API
- Gathering Interest
- relates to
-
CONFCLOUD-40457 Add REST API endpoint for generating space exports
- Gathering Interest
- mentioned in
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...