Skip to content

Add Actions API Access link to Action Platform APIs docs pages #2748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .generated-info
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"spec_repo_commit": "69305be",
"generated": "2025-08-05 16:20:40.645"
"spec_repo_commit": "3cfd0b6",
"generated": "2025-08-05 23:03:29.621"
}
90 changes: 17 additions & 73 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45042,6 +45042,7 @@ paths:
delete:
description: Delete an existing Action Connection. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: DeleteActionConnection
parameters:
- $ref: '#/components/parameters/ConnectionId'
Expand Down Expand Up @@ -45069,10 +45070,6 @@ paths:
summary: Delete an existing Action Connection
tags:
- Action Connection
x-permission:
operator: OR
permissions:
- connection_write
get:
description: Get an existing Action Connection. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Expand Down Expand Up @@ -46146,6 +46143,7 @@ paths:
delete:
description: Delete multiple apps in a single request from a list of app IDs.
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: DeleteApps
requestBody:
content:
Expand Down Expand Up @@ -46183,15 +46181,12 @@ paths:
summary: Delete Multiple Apps
tags:
- App Builder
x-permission:
operator: OR
permissions:
- apps_write
get:
description: List all apps, with optional filters and sorting. This endpoint
is paginated. Only basic app information such as the app ID, name, and description
is returned by this endpoint. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: ListApps
parameters:
- description: The number of apps to return per page.
Expand Down Expand Up @@ -46292,13 +46287,10 @@ paths:
summary: List Apps
tags:
- App Builder
x-permission:
operator: OR
permissions:
- apps_run
post:
description: Create a new app, returning the app ID. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: CreateApp
requestBody:
content:
Expand Down Expand Up @@ -46330,16 +46322,11 @@ paths:
summary: Create App
tags:
- App Builder
x-permission:
operator: AND
permissions:
- apps_write
- connections_resolve
- workflows_run
/api/v2/app-builder/apps/{app_id}:
delete:
description: Delete a single app. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: DeleteApp
parameters:
- description: The ID of the app to delete.
Expand Down Expand Up @@ -46386,13 +46373,10 @@ paths:
summary: Delete App
tags:
- App Builder
x-permission:
operator: OR
permissions:
- apps_write
get:
description: Get the full definition of an app. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: GetApp
parameters:
- description: The ID of the app to retrieve.
Expand Down Expand Up @@ -46448,14 +46432,10 @@ paths:
summary: Get App
tags:
- App Builder
x-permission:
operator: AND
permissions:
- apps_run
- connections_read
patch:
description: Update an existing app. This creates a new version of the app.
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: UpdateApp
parameters:
- description: The ID of the app to update.
Expand Down Expand Up @@ -46496,19 +46476,14 @@ paths:
summary: Update App
tags:
- App Builder
x-permission:
operator: AND
permissions:
- apps_write
- connections_resolve
- workflows_run
/api/v2/app-builder/apps/{app_id}/deployment:
delete:
description: Unpublish an app, removing the live version of the app. Unpublishing
creates a new instance of a `deployment` object on the app, with a nil `app_version_id`
(`00000000-0000-0000-0000-000000000000`). The app can still be updated and
published again in the future. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: UnpublishApp
parameters:
- description: The ID of the app to unpublish.
Expand Down Expand Up @@ -46549,15 +46524,12 @@ paths:
summary: Unpublish App
tags:
- App Builder
x-permission:
operator: OR
permissions:
- apps_write
post:
description: Publish an app for use by other users. To ensure the app is accessible
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
on the app if a policy does not yet exist. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: PublishApp
parameters:
- description: The ID of the app to publish.
Expand Down Expand Up @@ -46598,10 +46570,6 @@ paths:
summary: Publish App
tags:
- App Builder
x-permission:
operator: OR
permissions:
- apps_write
/api/v2/application_keys:
get:
description: List all application keys available for your org
Expand Down Expand Up @@ -67426,6 +67394,7 @@ paths:
post:
description: Create a new workflow, returning the workflow ID. This API requires
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: CreateWorkflow
requestBody:
content:
Expand Down Expand Up @@ -67461,14 +67430,11 @@ paths:
summary: Create a Workflow
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_write
/api/v2/workflows/{workflow_id}:
delete:
description: Delete a workflow by ID. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: DeleteWorkflow
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand Down Expand Up @@ -67496,13 +67462,10 @@ paths:
summary: Delete an existing Workflow
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_write
get:
description: Get a workflow by ID. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: GetWorkflow
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand Down Expand Up @@ -67540,13 +67503,10 @@ paths:
summary: Get an existing Workflow
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_read
patch:
description: Update a workflow by ID. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: UpdateWorkflow
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand Down Expand Up @@ -67590,14 +67550,11 @@ paths:
summary: Update an existing Workflow
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_write
/api/v2/workflows/{workflow_id}/instances:
get:
description: List all instances of a given workflow. This API requires a [registered
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: ListWorkflowInstances
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand All @@ -67624,13 +67581,10 @@ paths:
summary: List workflow instances
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_read
post:
description: Execute the given workflow. This API requires a [registered application
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: CreateWorkflowInstance
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand Down Expand Up @@ -67662,14 +67616,11 @@ paths:
tags:
- Workflow Automation
x-codegen-request-body-name: body
x-permission:
operator: OR
permissions:
- workflows_run
/api/v2/workflows/{workflow_id}/instances/{instance_id}:
get:
description: Get a specific execution of a given workflow. This API requires
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: GetWorkflowInstance
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand Down Expand Up @@ -67697,14 +67648,11 @@ paths:
summary: Get a workflow instance
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_read
/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
put:
description: Cancels a specific execution of a given workflow. This API requires
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
Alternatively, you can also configure these permissions [in our UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
operationId: CancelWorkflowInstance
parameters:
- $ref: '#/components/parameters/WorkflowId'
Expand All @@ -67727,10 +67675,6 @@ paths:
summary: Cancel a workflow instance
tags:
- Workflow Automation
x-permission:
operator: OR
permissions:
- workflows_run
security:
- apiKeyAuth: []
appKeyAuth: []
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/action_connection_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ def delete_action_connection(
) -> None:
"""Delete an existing Action Connection.

Delete an existing Action Connection. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Delete an existing Action Connection. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param connection_id: The ID of the action connection
:type connection_id: str
Expand Down
16 changes: 8 additions & 8 deletions src/datadog_api_client/v2/api/app_builder_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ def create_app(
) -> CreateAppResponse:
"""Create App.

Create a new app, returning the app ID. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Create a new app, returning the app ID. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:type body: CreateAppRequest
:rtype: CreateAppResponse
Expand All @@ -294,7 +294,7 @@ def delete_app(
) -> DeleteAppResponse:
"""Delete App.

Delete a single app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Delete a single app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param app_id: The ID of the app to delete.
:type app_id: UUID
Expand All @@ -311,7 +311,7 @@ def delete_apps(
) -> DeleteAppsResponse:
"""Delete Multiple Apps.

Delete multiple apps in a single request from a list of app IDs. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Delete multiple apps in a single request from a list of app IDs. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:type body: DeleteAppsRequest
:rtype: DeleteAppsResponse
Expand All @@ -329,7 +329,7 @@ def get_app(
) -> GetAppResponse:
"""Get App.

Get the full definition of an app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Get the full definition of an app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param app_id: The ID of the app to retrieve.
:type app_id: UUID
Expand Down Expand Up @@ -362,7 +362,7 @@ def list_apps(
) -> ListAppsResponse:
"""List Apps.

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param limit: The number of apps to return per page.
:type limit: int, optional
Expand Down Expand Up @@ -430,7 +430,7 @@ def publish_app(
) -> PublishAppResponse:
"""Publish App.

Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a `Restriction Policy <https://docs.datadoghq.com/api/latest/restriction-policies/>`_ on the app if a policy does not yet exist. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a `Restriction Policy <https://docs.datadoghq.com/api/latest/restriction-policies/>`_ on the app if a policy does not yet exist. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param app_id: The ID of the app to publish.
:type app_id: UUID
Expand All @@ -447,7 +447,7 @@ def unpublish_app(
) -> UnpublishAppResponse:
"""Unpublish App.

Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a ``deployment`` object on the app, with a nil ``app_version_id`` ( ``00000000-0000-0000-0000-000000000000`` ). The app can still be updated and published again in the future. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a ``deployment`` object on the app, with a nil ``app_version_id`` ( ``00000000-0000-0000-0000-000000000000`` ). The app can still be updated and published again in the future. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param app_id: The ID of the app to unpublish.
:type app_id: UUID
Expand All @@ -465,7 +465,7 @@ def update_app(
) -> UpdateAppResponse:
"""Update App.

Update an existing app. This creates a new version of the app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
Update an existing app. This creates a new version of the app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_. Alternatively, you can also configure these permissions `in our UI <https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access>`_.

:param app_id: The ID of the app to update.
:type app_id: UUID
Expand Down
Loading
Loading