Elastic Confluence connector reference

Elastic Confluence connector referenceedit

The Elastic Confluence connector is a connector for Atlassian Confluence.

Availability and prerequisitesedit

This connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.7.0+. To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.


To use this connector as a connector client, see Connector clients and frameworks.

For additional operations, see Usage.


  • Confluence Cloud or Confluence Server versions 7 or later.
  • Confluence Data Center editions are not currently supported.


When using the connector client workflow, initially these fields will use the default configuration set in the connector source code. These are set in the get_default_configuration function definition.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

Dropdown to determine the Confluence platform type: Confluence Cloud or Confluence Server. Default value is Confluence Server.
The username of the account for Confluence server.
The password of the account to be used for the Confluence server.
The account email for the Confluence cloud.
The API Token to authenticate with Confluence cloud.

The domain where the Confluence is hosted. Examples:

  • https://test_user.atlassian.net/

Comma-separated list of Space Keys to fetch data from Confluence server or cloud. If the value is *, the connector will fetch data from all spaces present in the configured spaces. Default value is *. Examples:

  • EC, TP
  • *
Whether SSL verification will be enabled. Default value is False.

Content of SSL certificate. Note: If ssl_enabled is False, the value in this field is ignored. Example certificate:

The number of retry attempts after failed request to Confluence. Default value is 3.
The number of concurrent downloads for fetching the attachment content. This speeds up the content extraction of attachments. Defaults to 50.

Deployment using Dockeredit

Follow these instructions to deploy the Confluence connector using Docker.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors-python/main/config.yml --output ~/connectors-python-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.password
  • connector_id
  • service_type

Use confluence as the service_type value. Don’t forget to uncomment "confluence" in the sources section of the yaml file.

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

  host: http://host.docker.internal:9200
  username: elastic
  password: <YOUR_PASSWORD>

service_type: confluence

  # UNCOMMENT "confluence" below to enable the Confluence connector

  #mongodb: connectors.sources.mongo:MongoDataSource
  #s3: connectors.sources.s3:S3DataSource
  #dir: connectors.sources.directory:DirectoryDataSource
  #mysql: connectors.sources.mysql:MySqlDataSource
  #network_drive: connectors.sources.network_drive:NASDataSource
  #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource
  #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource
  #postgresql: connectors.sources.postgresql:PostgreSQLDataSource
  #oracle: connectors.sources.oracle:OracleDataSource
  #mssql: connectors.sources.mssql:MSSQLDataSource

Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you. Normally you’ll only need to update elasticsearch.host, elasticsearch.password, connector_id and service_type to run the connector service.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-python-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors: \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to this guide in the Python framework repository for more details.

Documents and syncsedit

The connector syncs the following Confluence object types:

  • Pages
  • Spaces
  • Blog Posts
  • Attachments

Sync rulesedit

  • Content of files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
  • Filtering rules are not available in the present version. Currently filtering is controlled via ingest pipelines.

Content Extractionedit

See Content extraction.

Connector client operationsedit

End-to-end testingedit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the Confluence connector, run the following command:

$ make ftest NAME=confluence

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=confluence DATA_SIZE=small

Known issuesedit

There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.


See Troubleshooting.


See Security.

Framework and sourceedit

This connector is included in the Python connectors framework.

View the source code for this connector (branch 8.8, compatible with Elastic 8.8).