Get ahead of Confluence REST API v1 deprecation for Amazon Q Business and Amazon Kendra

Atlassian announced the deprecation of Confluence REST API v1, which will be removed from service on April 30, 2025. The Amazon Q Business and Amazon Kendra connectors will start using the v2 APIs ahead of this date on April 25, 2025. Customers should make updates by April 25. This represents a significant infrastructure change that affects many integrations, including the Amazon Q Business and Amazon Kendra Confluence connector. If your organization uses Amazon Q Business or Amazon Kendra to connect with Confluence, you'll need to update your OAuth integration settings to ensure continued functionality beyond the deprecation date.

This change was initially announced by Atlassian on March 1, 2023, with removal planned for December 2024. After developer feedback, the timeline was extended first to March 31, 2025, and most recently to April 30, 2025, giving organizations additional time to implement necessary changes. Atlassian has been working to address feature parity gaps between the two API versions and ensure a smoother transition for all users.

Organizations using the Amazon Q Business or Amazon Kendra Confluence connector need to verify if their current integration works with the new Confluence REST API v2, and if not, update their OAuth integration accordingly. Completing this task now will prevent potential disruptions to your Amazon Q Business service when the v1 API is decommissioned.

Before making any changes, determine if your connector is already configured to work with Confluence REST API v2:

Step 1. Log in to your AWS console

Step 2. Open Secrets Manager

Step 3. Locate and open the secret you created for your Confluence connector

Step 4. Under "Overview" → "Secret value," click on "Retrieve secret value"

Step 5. Copy your confluenceAppKey, confluenceAppSecret, and confluenceRefreshToken using the adjacent copy buttons and save for the next step.

Step 6. Open a terminal on your device

Step 7. Generate a new Confluence (Cloud) access token using your saved items in the previous steps. Run the following commands:

You will receive a response as follows:

Step 8. Run the following commands to get your confluence cloud ID:

You will receive a response as follows:

Make sure to copy/save the id; you will need to use it in subsequent steps.

Step 9: Run the following command to test if your connector is already setup to use the Confluence REST API v2

Step 10: Review the response

If you get a response with a 401 error code, follow the remaining instructions in this document to update your Confluence connector to work with the Confluence REST API v2.

However, if you instead get a successful response as shown below below, your connector is already setup to work with the Confluence REST API v2 and you can skip all remaining steps in this document.

Step 1: Log in to the Atlassian developer site and go to the OAuth app integration you created for your Q Business or Kendra application.

Step 2: In the left navigation menu, click Permissions.

Step 3: Select the Granular scopes tab and click Edit scopes.

Step 4: Verify that you have enabled the following granular scopes and if not, add them:

Required Scopes:

Optional recommended scopes:

Step 5: In your left navigation bar, click Authorization.

Step 6: Copy the Granular Confluence API authorization URL from the Authorization URL generator and save it for later.

Step 7: Generate a new access token using the steps detailed in our documentation and save it for later.

Step 8: Generate a new refresh token using the steps detailed in our documentation and save it for later.

Step 9: Log in to your AWS console.

Step 10: Open Secrets Manager.

Step 11: Locate and open the secret you created for your Q Business or Kendra Confluence connector.

Step 12: Under Overview > Secret value, click Retrieve secret value.

Step 13: Click Edit and insert the access token and refresh token you acquired under values for confluenceAccessToken and confluenceRefreshToken, and click Save.

Congrats! Your Confluence connector is now set up to work with Confluence REST API v2.

After completing these steps, your Amazon Q Business or Amazon Kendra Confluence connector will be compatible with Confluence REST API v2, ensuring uninterrupted service when the v1 API is decommissioned on April 30, 2025. Your users will continue to enjoy seamless access to Confluence content through Amazon Q Business or Amazon Kendra, with all search and retrieval capabilities working as expected.

This proactive update eliminates the risk of sync failures that would occur if using the deprecated API after the removal date. Additionally, the new API version provides better performance and security through its improved architecture and granular permission model.

Test your updated connection by performing a few sample queries through Amazon Q Business or through Amazon Kendra to verify that Confluence content is being retrieved correctly. If you encounter any issues or have questions about this process, please refer to the AWS documentation or contact AWS Support.

By staying ahead of this API deprecation, you're ensuring that your organization can continue to leverage the full power of Amazon Q Business and Amazon Kendra with your valuable Confluence knowledge base.