Add Actions API Access to API and Application Keys #30922
Conversation
📝 Documentation Team Review RequiredThis pull request requires approval from the @DataDog/documentation team before it can be merged. Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes. |
Preview links (active after the
|
| - [Actions Connections][6] | ||
| - [Workflow Automation][7] | ||
|
|
||
| Each API requires specific permissions for individual endpoints. Because these APIs often work together, there is a simplified scoping process through the **Actions API Access** feature. Enabling **Actions API Access** adds all the required permissions for the Actions Platform APIs. |
There was a problem hiding this comment.
Sorry I didn't ask about this earlier when we discussed your work! What is Actions API Access? Is it a permission? If not, how do users enable it? It sounds like a permission. Elsewhere in this doc, we assume that people already know how to set permissions.
There was a problem hiding this comment.
User opt-in by clicking a button in the application key settings or by using the API "register an app key for actions API usage." This is similar to how users can enable Remote Config on API keys.
I think the wording could be better here. Maybe something like:
"In order to use application keys with these APIs, you must enable Actions API access on the application key, which can be done via the UI (screenshot) or API (link to API docs). By default, application keys cannot be used with these APIs."
| - [Actions Connections][6] | ||
| - [Workflow Automation][7] | ||
|
|
||
| Each API requires specific permissions for individual endpoints. Because these APIs often work together, there is a simplified scoping process through the **Actions API Access** feature. Enabling **Actions API Access** adds all the required permissions for the Actions Platform APIs. |
There was a problem hiding this comment.
User opt-in by clicking a button in the application key settings or by using the API "register an app key for actions API usage." This is similar to how users can enable Remote Config on API keys.
I think the wording could be better here. Maybe something like:
"In order to use application keys with these APIs, you must enable Actions API access on the application key, which can be done via the UI (screenshot) or API (link to API docs). By default, application keys cannot be used with these APIs."
Co-authored-by: Ursula Chen <58821586+urseberry@users.noreply.github.com>
…Dog/documentation into olivia.shoup/add-actions-api-access
Co-authored-by: Ursula Chen <58821586+urseberry@users.noreply.github.com>
What does this PR do? What is the motivation?
This PR adds a new section to API and Application Keys about the new feature for Actions API Access.
Merge instructions
Merge readiness:
Additional notes
This PR is related to a separate PR in the datadog-api-spec repo. While this PR adds text to explain the new feature, the other PR removes the previously required permissions from the API docs. The new section from this PR is linked in the API docs instead.