Confluence REST Connector 25.1
Confluence REST Connector Help

# Retrieve Information from Confluence

To automatically retrieve content from Confluence, create a new fetch task by following these steps. The connector runs each fetch task automatically, based on the schedule that is configured in the configuration file.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, set the following parameters:

   `ConfluenceHost` | The host name or IP address of the machine that hosts the Confluence instance.
   `ConfluencePort` | The port to use to connect to Confluence.
   `UseSecureConnection` | Specifies whether to connect to Confluence using HTTPS. To use HTTPS, rather than HTTP, set this parameter to `TRUE`.
   `MappedSecurity` | Specifies whether to enable mapped security. To extract security information from the repository and add an Access Control List (ACL) to each document, set this parameter to `TRUE`.

2. Specify the information required by the connector to authenticate with Confluence.

   - To use HTTP basic authentication, set the following parameters:

     `BasicUsername` | The user name to use to retrieve data from Confluence.
     `BasicPassword` | The password to use to retrieve data from Confluence.

     With cloud-hosted instances of Confluence, you can obtain an API token by following the procedure in the Confluence documentation (log in as the user account that you want to use for the connector). Set the `BasicUsername` parameter to the e-mail address of the user account, and set the `BasicPassword`parameter to the API token.

   - To use OAuth authentication, follow the instructions in Configure OAuth Authentication. After using the OAuth configuration tool to generate the file `oauth.cfg`, import the parameters into the connector configuration file:

         [MyTask] < "oauth.cfg" [OAUTH]

     For more information about including parameters from another file, see Include an External Configuration File.

3. (Optional) You can set additional parameters to choose which information to ingest. For example:

   `SpaceMustHaveRegex` | A regular expression to restrict the spaces that are ingested. Unless the title of a space matches the regular expression, the space and all of its child pages and blog posts are ignored.
   `SpaceCantHaveRegex` | A regular expression to restrict the spaces that are ingested. If the title of a space matches the regular expression, the space and all of its child pages and blog posts are ignored.

   For a complete list of configuration parameters that you can use, refer to the Confluence REST Connector Reference.

4. Save and close the configuration file.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Confluence REST Connector 25.1

Topic Title: Retrieve Information from Confluence