Delete Task Histories
Delete the history of one or more tasks by ID. Only tasks in a terminal/immutable state (completed successfully or failed non-retriable) can be deleted. Each task is processed independently; the response reports per-task success and failure.
List of task IDs whose history should be deleted
Show optional properties
{
"taskIds": [
{}
]
}{
"taskIds": [
"string"
]
}taskIds
Operation completed. Check 'successful' and 'failed' lists in the response for per-task results.
{
"successful": [
"string"
],
"failed": [
{
"taskId": "string",
"errorCode": "string",
"message": "string"
}
]
}successful
failed
Invalid request body (e.g. empty taskIds list).
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"referenceToken": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Unexpected error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"taskIds":["string"]}' https://{api_host}/v1/tasks/history