What is changing?
Confluence Cloud is announcing the start of a deprecation period for a number of v1 API endpoints, please see the changelog: https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-864 for full details.
We intend to remove public access to these endpoints following the 6 month deprecation period, which means any apps still using v1 will no longer have access and will need to move to the new, v2 API endpoints.
Why is it changing?
We are deprecating in favor of v2 endpoints that provide a couple of key benefits over v1, specifically:
- Better performance, especially for bulk endpoints! Moving to cursor-based pagination has provided significant performance gains over v1’s offset-based pagination, especially at high offsets. This should be a big win for apps that go through all content on Confluence.
- More granular endpoints, that allow you to be specific about the type of data being used. Not only does this result in more clear documentation and functionality, but will help prospective app consumers feel more confident about the type of data apps will have access to.
What do I need to do?
If you are the owner of a Confluence Cloud app, or are otherwise using the Confluence Cloud APIs, please ensure you are not using any endpoints marked for deprecation. If you are, plan to migrate to v2 API endpoints before September 1st 2023. If you have any concerns or difficulties migrating, please respond to this post. We do not intend to remove functionality, so if you are unable to migrate due to a capability gap or unexpected behavior, please let us know!
By when do I need to do it?
The six-month deprecation period for these changes begins on March 1st 2023 . Public access to these endpoints will be removed on September 1st 2023 .
April 2023 UPDATE: We are providing a short extension to the deprecation period. As an exception to our normal deprecation notice policy, the period will now be extended to 10 months. We will remove public access to these endpoints on January 1st 2024.