Cancel an in-progress record deletion task in Dynatrace with the Grail Storage Record Deletion API. It stops queued subtasks and returns accepted cancellation.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/storage/record/v1/delete:cancel |
You provide the taskId in the request body to cancel a submitted record deletion process. Dynatrace cancels subtasks that have not started yet and returns an accepted response for the cancellation request.
To execute this request, you need a platform token or OAuth access token with storage:records:delete scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Deleted | Cancel request | body | Required |
DeletedRecordsProcess object| Element | Type | Description | Required |
|---|---|---|---|
| taskId | string | - | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"taskId": "49eb7d8e-806a-4829-9d29-c2a92e642366"}
| Code | Type | Description |
|---|---|---|
| 202 | Cancel | Accepted cancellation of the submitted record deletion process. |
| 204 | - | There is no deletion task to cancel. |
| 400 | Error | Bad request for cancelling the submitted record deletion process. |
| 401 | Error | Unauthorized. |
| 403 | Error | Access forbidden. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Exceptional | - |
ExceptionalReturn object| Element | Type | Description |
|---|---|---|
| code | integer | - |
| errorDetails | (Custom | - |
| message | string | - |
CustomValidationErrorInfo objectErrorInfo object| Element | Type | Description |
|---|---|---|
| message | string | - |
InvalidAuditEventsErrorInfo objectMediaTypeErrorInfo objectParameterErrorInfo objectProxyErrorInfo objectQueryFrontendRawErrorInfo objectRequestBodyErrorInfo object{"error": {"code": 1,"errorDetails": [{"message": "string"}],"message": "string"}}