Local Delete

Local Delete

Certified

Delete local file or directory

Removes a file or directory under the configured allowed-paths; access outside is denied. Recursive deletion is disabled by default. To delete a non-empty directory and its contents, set recursive: true. Set errorOnMissing: true to fail when the target is absent.

Example (Kestra config):

plugins: 
  configurations: 
    - type: io.kestra.plugin.fs.local.Delete
      values: 
        allowed-paths: 
          - /data/files
yaml
type: io.kestra.plugin.fs.local.Delete
yaml
id: fs_local_delete
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.fs.local.Delete
    from: /data/uploads/file.txt
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-fs --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Local path to delete

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Raise an error if missing

Defaultfalse

Include subdirectories

If true, deletes directory contents recursively. Defaults to false.

A regular expression to filter files for deletion

When set, from must point to a directory. The pattern is matched against the absolute OS path of each file (for example, /data/uploads/file.csv). Only regular files are deleted; directories are skipped.

Defaultfalse

Whether the file was deleted

Formaturi

URI of the deleted file or directory, or the target directory when regExp is used

SubTypestring

URIs of all deleted files when regExp is used