Skip to main content
Skip table of contents

Creating an Export using the REST API

This page describes how to create an export using the REST API. This might be useful, if you want to automatically create documentation with every nightly build. For more information about using the REST API in Confluence see: Using the REST APIs.

Info

If you want to create an export of thousands of pages, please have a look at the page How Can I get the REST URL before Export?. You should also consider using the asynchronous API in this case.

 Before you begin: Before getting the URL, you have to export your content to CHM.

Getting the URL 


To get the URL:

  1. Click Page Tools (•••) > Export to CHM.
    The screen Export to CHM and the existing export schemes are displayed.
  2. Select the wanted export scheme and click Start Export.
    The progress bar is displayed.
  3. Click REST URL, copy the displayed URL and click Close.

The REST URL is copied and can now be used in your script, see the curl and wget examples below.


Using the URL

The URL can be used with different tools.

Authentication

You can authenticate yourself for the REST APIs in three ways.

Basic HTTP authentication offers the best password security

We recommend using the basic HTTP authentication protocol, as it offers the best password security. Please note, in Confluence 7.12 (and later) Atlassian plans to let admins disable basic authentication (see section 'Changes to basic authentication' here) and our REST API does not support Atlassian's new approach for using personal access tokens instead. This means that if Basic Authentication is disabled it will not be possible to use the REST API with Scroll PDF Exporter.

  • Log in to Confluence manually You will then be authenticated for the REST APIs for that same browser session.
  • Use HTTP basic authentication (Authorization HTTP header) containing 'Basic username:password'. (warning) username:password must be base64 encoded. The URL must also contain the 'os_authType=basic' query parameter.

  • Using URL parameters You may specify your username and password in the URL using the 'os_username' and 'os_password' parameters. The user credentials in the URL do not need to come from the admin – they can be from any user with view permissions for the space.See below for examples.

    Using Confluence 7.10 or later?


    Please note that since Confluence 7.10, Atlassian has introduced changes that will affect those who authenticate themselves using query parameters (see section 'Seraph upgrade' here). As a result, authentication using URL parameters will not work by default. Therefore, if you're relying on the os_username+os_password query parameter, you'll need to add the atlassian.allow.insecure.url.parameter.login=true system property in your Confluence instance.

If you want to use some non-browser tool like wget or curl, you probably have to use either HTTP basic authentication or URL parameters.

curl 

Curl is a command line tool for transferring data with URL syntax. It is preinstalled on MacOS X and available for all Linux distributions using the package manager. There are also builds for Windows available.

You can use curl using the command line as follows. On MacOS X and Linux please make sure to place the URL in double quotes as otherwise the "&" character inside the URL will break the command.

HTTP basic authentication:

CODE 
curl --remote-header-name --remote-name -u admin:admin "http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_authType=basic"

URL parameter based authentication:

CODE 
curl --remote-header-name --remote-name "http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_username=admin&os_password=admin"

Note

 In some cases the colons are replaced with '&3A'. Please check the permalink carefully and edit it if necessary.

If you want to call curl from a script, the "-f" parameter may be interesting as it will make curl return some non-zero return value in case of download errors. See the curl documentation for more info.

wget 

wget is another command line tool for transferring data with URL syntax. It is available for all major platforms.

You can use wget using the command line as follows. On MacOS X and Linux please make sure to place the URL in double quotes as otherwise the "&" character inside the URL will break the command.

HTTP basic authentication:

CODE 
wget --content-disposition --http-user=admin --http-password=admin "http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_authType=basic"

URL parameter based authentication:

CODE 
wget --content-disposition "http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_username=admin&os_password=admin"

Other Tools 

If you use other tools, you can compose the URL as described below.

HTTP basic authentication:

CODE 
[http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_authType=basic]

URL parameter based authentication:

CODE 
[http://www.example.com/confluence/rest/scroll-chm/1.0/sync-export?exportSchemeId=7F00000101316644174326E600DED2BA&pageId=32769&os_username=admin&os_password=admin]

Asynchronous Export

Sometimes it might be necessary to asynchronously trigger the export. We recommend to use this API if you want to expect a large number of pages.

While this script is not officially supported, you may use the example bash-script linked below.

To asynchronous export your content:

  1. Download the example bash-script.
  2. Open the bash-script with a text-editor.

  3. Edit the following values:

    ValueDescription
    hostEnter your Confluence server URL.
    exportSchemeIdEnter the exportSchemeId.
    rootPageIdEnter the Id of the page you want to start the export from.
    usernameEnter the username of the user performing the export.
    passwordEnter the password of the user performing the export.
    product

    Enter the plugin-key of your exporter:

     scroll-chm

    versionId

    This value only works when Scroll Versions is also activated in the space

    Enter the Id of the version you would like to export

    variantId

    This value only works when Scroll Versions is also activated in the space

    Enter the Id of the variant you would like to export. 

    Or use variantId=all for all variants.


  4. Save the file

You can now use this script to automatically start your exports.


Exporting without saved Export Scheme

You can also perform an export without saving an Export Scheme first. This is helpful if you do not want the specific Export Scheme to appear on the Confluence UI, or if your export settings are generated dynamically.

This works by POSTing the Export Scheme data to the export REST endpoint, instead of specifying a saved Export Scheme.

To do that:

  1. ExportSpec
  2. exporting

Preparing the Export Specification File

The Export Specification File must be stored in JSON format and must contain the root page of the export, the Export Scheme data and (optional) details from Scroll Versions / Scroll Translations to export the correct version, variant, or language.

To prepare the Export Specification File:

  1. Create a temporary Export Scheme with your settings and save it for now.
  2. Get the ID of the temporary Export Scheme from the REST URL as described in the get.

  3. Download the Export Scheme as file using the following curl command:

    Download export-scheme.json

    CODE 
    curl -H "Accept:application/json" "http://localhost:1990/confluence/rest/scroll-chm/1.0/export-scheme/-C0A81178014CC162A59E7BAB1D2F8FBA" --output export-scheme.json

  4. If you do not need the temporary Export Scheme, delete it.

  5. Create your Export Specification File as a new text file with the following content: 

    export-spec.json (template)

    CODE 
    {
    "rootPageId": "<ROOT_PAGE_ID>",
    "versionId": "<VERSION_ID>",
    "variantId": "<VARIANT_ID>",
    "languageKey": "<LANGUAGE_KEY>",
    "exportScheme": <EXPORT_SCHEME_DATA>
}
  6. Enter the details in this file:
    1. Replace <ROOT_PAGE_ID> with the ID of the Confluence page that your export should start on.
      (info) This is required.
    2. Replace <VERSION_ID>, <VARIANT_ID> and <LANGUAGE_KEY> with the respective values from the REST URL.
      (info) All of these fields are optional. If you don't need them remove the respective lines.
    3. Replace <EXPORT_SCHEME_DATA> with the contents of the export scheme file.
      (info) This is required.
      Your export spec file should now look like this:

export-spec.json (example)

CODE 
{
    "rootPageId": "10158113",
    "versionId": "AE5345ASFD3231",
    "variantId": "CF34B56543AED1",
    "languageKey": "en",
    "exportScheme": {
        "id": "C0A81178014CC162A59E7BAB1D2F8FBA",
        "name": "My temporary Export Scheme",
        "pageSelectionStrategy": { ... },
        "pageBuilder": { ... },
        "exporter": { ... },
        "exportAdhocPublishedOnly": false
    }
}

Performing the Export

Use curl to perform the export and specify the Export Specification File to upload using the following curl command:

CODE 
curl -H "Content-Type:application/json" --data-binary @/path/to/export-spec.json --remote-header-name --remote-name -u admin:admin "http://localhost:1990/confluence/rest/scroll-chm/1.0/sync-export?os_authType=basic"

This posts the data from the referenced Export Specification File to the REST endpoint and performs the export with these settings.

It is also possible to POST this data to the asynchronous REST API.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close