Release OTR mode for application key #29541
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Preview links (active after the
|
jackakeller
reviewed
Jun 24, 2025
| - Application key secrets are only visible once, immediately after creation | ||
| - The raw values cannot be retrieved later via the UI or API | ||
| - You must securely store the key value when it is first displayed | ||
|
|
There was a problem hiding this comment.
Should we mention the v1 API change here too?
ℹ️ Documentation Team ReviewNo documentation team review is required for this pull request. |
jackakeller
reviewed
Jun 24, 2025
| @@ -142,3 +154,4 @@ Need help? Contact [Datadog support][16]. | |||
| [15]: /api/latest/service-accounts/ | |||
| [16]: /help/ | |||
| [17]: /account_management/org_settings/service_accounts/ | |||
| [18]: https://app.datadoghq.com/organization-settings/ | |||
There was a problem hiding this comment.
Can we link directly to the application keys page?
https://app.datadoghq.com/organization-settings/application-keys
emubello
reviewed
Jun 25, 2025
| @@ -16,6 +16,18 @@ API keys are unique to your organization. An [API key][1] is required by the Dat | |||
|
|
|||
There was a problem hiding this comment.
Do we need to mention what behavior child-orgs of orgs in otr mode could have?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation for the new One-Time Read (OTR) mode feature for Application Keys. This security enhancement limits the visibility of application key secrets to creation time only, aligning with industry best practices.
Changes
Updated two main documentation files:
content/en/account_management/api-app-keys.md:content/en/account_management/org_settings.md:Key Documentation Points
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes