Core Plugins and tasks PurgeAuditLogs

Core Plugins and tasks PurgeAuditLogs
Certified
Purge audit logs older than a certain date.

This task can be used to save space in the database by purging audit logs older than a certain date.

yaml
type: io.kestra.plugin.ee.core.log.PurgeAuditLogs

Examples

Purge audit logs older than one month.

yaml
id: audit_log_cleanup
namespace: system
tasks:
  - id: purge_audit_logs
    type: io.kestra.plugin.ee.core.log.PurgeAuditLogs
    description: Purge audit logs older than 1 month
    endDate: "{{ now() | dateAdd(-1, 'MONTHS') }}"

Purge audit logs related to FLOW & EXECUTION permission created more than one month ago.

yaml
id: purgeauditlogs
type: io.kestra.plugin.ee.core.log.PurgeAuditLogs
endDate: "{{ now() | dateAdd(-1, 'MONTHS') }}"
resources:
- FLOW
- EXECUTION

Properties

endDate *string

The maximum date to be purged

All audit logs older than this date will be purged. We recommend using this property rather than startDate as your Audit Log retention policy.

namespace string

Namespace for which audit logs should be purged

This property declares a namespace prefix (or namespace of a specific flow if flowId is also provided) to be purged.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

resources array

SubTypestring

Possible Values

AUDITLOGAPPASSETAPP_EXECUTIONBLUEPRINTBINDINGDASHBOARDEXECUTIONFLOWKILL_SWITCHKV_STOREGROUPINVITATIONNAMESPACENAMESPACE_FILEROLESECURITY_INTEGRATIONSECRETSETTINGTEMPLATETRIGGERTENANTTENANT_ACCESSTESTSUITETESTSUITE_RUNVERSIONED_PLUGINUSERCREDENTIALWORKER_GROUPINSTANCEUNKNOWN

The resources to be purged

The resources of audit logs to be purged; by default, the task will purge all audit logs including all resources.

startDate string

The minimum date to be purged

All audit logs created after this date will be purged. Use this option only if you want to purge recently generated logs after a certain date.

types array

SubTypestring

Possible Values

READCREATEUPDATEDELETELOGINLOGOUTIMPERSONATELOGIN_FAILUREACCOUNT_LOCKED

The type of CRUD actions to be purged

Use this option if you want to purge only specific actions like CREATE, READ, UPDATE, or DELETE. By default, the task will purge all types of actions.

Outputs

count integer

Default0

The count of deleted audit logs