provider Workflow Automation PUT /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel
@utdk/datadog /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel
Cancel a workflow instance
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 configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
workflow_id path required
The ID of the workflow.
string
instance_id path required
The ID of the workflow instance.
string

Try it

Authentication
Configure credentials for Datadog API V2 Collection
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

cancelworkflowinstance
PUT/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel
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 configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

Parameters

required

The ID of the workflow.

required

The ID of the workflow instance.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import datadog from '@utdk/datadog';

await datadog.cancelworkflowinstance()