Use Case:

The recently released "Edit Space Key" feature in Confluence Cloud allows users to rename space keys seamlessly without breaking existing references. This enhancement ensures both the original (system space key) and the new (alias) space key work across the platform, preserving links and functionality. However, the current implementation of the get spaces and get space by id APIs only returns the original space key in the space key field. There is no additional field to reflect the new alias space key, limiting the usability of the APIs for integrations and reporting purposes.

Suggestion:

To maximize the utility of the "Edit Space Key" feature, we propose adding a new field in the API responses (e.g., aliasSpaceKey) to reflect the updated alias space key. This ensures that both the original and the new space key are accessible in the API outputs, providing a complete and transparent view of space identifiers.

Proposed Impact of the Improvement:

Adding the alias space key field will:

1. Enhance API usability for developers and administrators relying on accurate space key data for integrations and automation.
2. Simplify management and reporting of renamed spaces by providing both the original and alias space keys in a single API call.
3. Address a critical issue for customers who need to fetch the current space key and display it in their records using REST APIs. Without an alias field, these users are forced to rely on the outdated original space key, which can lead to incorrect or outdated information being reflected in their automated processes and records.