ftp_delete

Deletes a file or directory on the FTP/SFTP server. Must be used inside an ftp_session block.

{% ftp_session host: "ftp.example.com", user: "myuser", password: "mypass" %}
  {% ftp_delete target: "/temp/old_file.csv" as result %}

  {% if result.ok %}
    {% log "File deleted" %}
  {% endif %}
{% endftp_session %}

Syntax

{% ftp_delete target: "/path/to/file_or_directory" as result_variable %}

Parameters

Parameter	Required	Description
target	Yes	Path to the file or directory to delete
recursive	No	Set to true to delete directories with contents

Result Object

Property	Type	Description
ok	boolean	true if deletion succeeded
error	string/null	Error message if ok is false, null on success

Example result:

{
  "ok": true,
  "error": null
}

Examples

Delete a single file:

{% ftp_session host: FTP_HOST, user: FTP_USER, password: FTP_PASSWORD %}
  {% ftp_delete target: "/temp/report.csv" as result %}

  {% if result.ok %}
    {% log "File deleted successfully" %}
  {% else %}
    {% log result.error %}
  {% endif %}
{% endftp_session %}

Delete an empty directory:

{% ftp_session host: FTP_HOST, user: FTP_USER, password: FTP_PASSWORD %}
  {% ftp_delete target: "/old_folder" as result %}
{% endftp_session %}

Delete directory with all contents (recursive):

{% ftp_session host: FTP_HOST, user: FTP_USER, password: FTP_PASSWORD %}
  {% ftp_delete target: "/temp/old_exports", recursive: true as result %}

  {% if result.ok %}
    {% log "Directory and all contents deleted" %}
  {% endif %}
{% endftp_session %}

Clean up old files:

{% ftp_session host: FTP_HOST, user: FTP_USER, password: FTP_PASSWORD %}
  {% ftp_list path: "/logs" as list_result %}

  {% assign cutoff = "now" | date: "%s" | minus: 604800 %}
  {% comment %} 604800 seconds = 7 days {% endcomment %}

  {% for file in list_result.files %}
    {% if file.modifiedAt < cutoff %}
      {% ftp_delete target: file.path as delete_result %}
      {% if delete_result.ok %}
        {% log "Deleted old file: " %}
        {% log file.name %}
      {% endif %}
    {% endif %}
  {% endfor %}
{% endftp_session %}

Process, archive, then delete original:

{% ftp_session host: FTP_HOST, user: FTP_USER, password: FTP_PASSWORD %}
  {% ftp_list path: "/inbox", pattern: "*.csv" as files %}

  {% for file in files.files %}
    {% ftp_download from: file.path as download %}

    {% if download.ok %}
      {% comment %} Process the file... {% endcomment %}
      {% assign content = download.file.name | content %}

      {% comment %} Delete original after successful processing {% endcomment %}
      {% ftp_delete target: file.path as delete_result %}

      {% if delete_result.ok %}
        {% log "Processed and removed: " %}
        {% log file.name %}
      {% endif %}
    {% endif %}
  {% endfor %}
{% endftp_session %}

Notes

• Must be used inside an ftp_session block

• Consumes 2 credits per operation

• Use recursive: true with caution - it permanently deletes all contents

• Cannot delete non-empty directories without recursive: true

• Operation cannot be undone