Cancel an execution in Dynatrace with the AutomationEngine API when it is active, using the execution ID and optional admin access.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/automation/v1/executions/{id}/cancel |
You provide the execution ID in the path and can use the adminAccess query parameter to allow access to all workflows and executions. Dynatrace returns no response body when the AutomationEngine API accepts the cancel request.
To execute this request, you need a platform token or OAuth access token with automation:workflows:run scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin | query | Optional |
| id | string | A UUID string identifying this execution. | path | Required |
| Code | Type | Description |
|---|---|---|
| 204 | - | No response body |
| 4XX | Error | - |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| message | string | - |
| code | integer | - |
| details | Error | - |
ErrorDetails object| Element | Type | Description |
|---|---|---|
| errorCode | string | - |
| errorRef | string | - |
{"error": {"message": "string","code": 1,"details": {"errorCode": "string","errorRef": "string"}}}