---
title: "Confluence Cloud"
canonical_url: "https://docs.getdx.com/connectors/confluence-cloud/"
md_url: "https://docs.getdx.com/connectors/confluence-cloud.md"
last_updated: "2026-05-08"
---

# Confluence Cloud
By integrating Confluence Cloud with DX, you can analyze documentation contributions and metrics such as new docs created and updates. Please refer to the API documentation below and our [schema explorer](https://docs.getdx.com/schema/) to see what data DX imports.

## Prerequisites

To connect Confluence Cloud to DX, you need:

- a [Managed account](https://confluence.atlassian.com/cloudkb/profile-visibility-defaults-for-atlassian-accounts-1116292287.html)
- a service account and API token

## Setup instructions

Follow the steps below to connect Confluence Cloud to DX:

#### Step 1

Create a Confluence service account to be used for DX—the service account must have access to the spaces that you want to import.

#### Step 2

**Create a Scoped Token**

- Begin service account creation via [admin.atlassian.com](https://admin.atlassian.com/) under Directory -> Service accounts
- Grant the service account access to the Confluence App with the User Role
- When directed, specify the following scopes for the token:
  - **Read:**
    - `read:space:confluence`
    - `read:page:confluence`
    - `read:user:confluence`
    - `read:confluence-content.summary`
- Save this token to be used when connecting via DX
- Find your cloud ID to build your base API URL at `https://<my-site-id>/_edge/tenant_info`
  - This should show a hash with a single key value pair that looks like `{"cloudId":"15ace26c-a7e9-49d6-9e1e-5e90906e946e"}`
- Use `https://api.atlassian.com/ex/confluence/<cloud-id>` as the base URL
  - eg. `https://api.atlassian.com/ex/confluence/15ace26c-a7e9-49d6-9e1e-5e90906e946e`
- For the username, use the generated service account email. It should end in `serviceaccount.atlassian.com`

#### Step 3

- Navigate to the connections page in DX and select "+ Connection" in the top right.
- Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.
  - Your username will be an email address and API token will be a long string beginning with 'ATATT3x'

> **Deprecated Authentication Alternative: Unscoped Token** - To setup a connection, you can also use an [unscoped API Token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) created using the **Create API Token** option under **Manage API Tokens** at [id.atlassian.com](https://id.atlassian.com/manage-profile/security/api-tokens). When using an unscoped token, you must use the `<my-id>.atlassian.net` version of your base URL (e.g., `https://my-company.atlassian.net`). We recommend using scoped tokens, but will continue accepting unscoped tokens indefinitely.

## API reference

The table below lists the specific API endpoints that are used by DX.


| Endpoint | Documentation |
|-------------------------------------------------------|---------------|
| /wiki/api/v2/spaces | [Link](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-get) |
| /wiki/api/v2/pages | [Link](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get) |
| /wiki/api/v2/pages/{pageId}/versions | [Link](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version/#api-pages-id-versions-get) |
| /wiki/api/v2/pages/{pageId}/labels | [Link](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label/#api-pages-id-labels-get) |
| /wiki/api/v2/users-bulk | [Link](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/#api-users-bulk-post) |
| /wiki/rest/api/analytics/content/{contentId}/views | [Link](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/#api-group-analytics) |
| /wiki/rest/api/content/{id}/state | [Link](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/#api-wiki-rest-api-content-id-state-get) |


## Errors

The table below lists potential error codes when adding a connection in DX.


| Error | Description |
|----------------------|------------------------------------------------------------------------------------------------------------------|
| `invalid_credentials` | Your API credentials entered are not valid. |
| `invalid_permissions` | Your API token does not have the permissions required by DX. |
---

## Sitemap

[Overview of all docs pages](/llms.txt)