Purge executions, logs, metrics, and storage files.
This task can be used to purge flow executions data for all flows, for a specific namespace, or for a specific flow.
type: "io.kestra.plugin.core.execution.purgeexecutions"Examples
Purge all flow execution data for flows that ended more than one month ago.
id: "purgeexecutions"
type: "io.kestra.plugin.core.execution.purgeexecutions"
endDate: "{{ now() | dateAdd(-1, 'MONTHS') }}"
states:
- KILLED
- FAILED
- WARNING
- SUCCESSProperties
endDate *Requiredstring
The maximum date to be purged.
All data of flows executed before this date will be purged.
flowId string
The flow ID to be purged.
You need to provide the namespace properties if you want to purge a flow.
namespace string
Namespace whose flows need to be purged, or namespace of the flow that needs to be purged.
If flowId isn't provided, this is a namespace prefix, else the namespace of the flow.
purgeExecution booleanstring
trueWhether to purge executions.
purgeLog booleanstring
trueWhether to purge execution's logs.
This will only purge logs from executions not from triggers, and it will do it execution by execution.
The io.kestra.plugin.core.log.PurgeLogs task is a better fit to purge logs as it will purge logs in bulk, and will also purge logs not tied to an execution like trigger logs.
purgeMetric booleanstring
trueWhether to purge execution's metrics.
purgeStorage booleanstring
trueWhether to purge execution's files from the Kestra's internal storage.
startDate string
The minimum date to be purged.
All data of flows executed after this date will be purged.
states array
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTThe state of the executions to be purged.
If not set, executions for any states will be purged.
Outputs
executionsCount integer
0The count of deleted executions.
logsCount integer
0The count of deleted logs.
metricsCount integer
0The count of deleted metrics.
storagesCount integer
0The count of deleted storage files.