Covered in this article
Related pages
Latest Changelog
Version 1.4.4 ()
SFTP component

SFTP component

A component for connecting to an SFTP server to read/write files.

General Information

Description and Purpose

This component creates a connection to an SFTP server to read and upload files.

The optional environment variable MAX_FILE_SIZE should be set in settings to provide the maximum file size that can be uploaded in megabytes (mb). The default value for MAX_FILE_SIZE is 100MB.

Technical Notes

The technical notes page gives some technical details about SFTP component like changelog.


  • Host - Host name of SFTP server

  • Port - Optional, port of SFTP server. Defaults to 22 if not set.

  • User Name - Username for SFTP server

  • Password - Password for SFTP server.

Note: field Private Key should stay empty in case you fill a password.

Private Key

To access a secure SFTP servers that is configured with a key-based authentication you must at first upload your Public key to the SFTP server (please contact your server administrator to do this) and fill in this field with your Private key.

Also please pay attention that the field Password should be empty in this case.

My new SFTP credential


SFTP component includes the following triggers:

  1. Read files
    Will continuously poll remote SFTP location for files that match given pattern. Found files will be transferred as attachments to the next component.

  2. Poll files
    Triggers to get all new and updated files since last polling.


SFTP component includes the following actions:

  1. Upload files From Attachments Header
    Upload all files from the attachments header to a defined SFTP directory.

  2. Upload File From URL
    Given a filename and a URL to an attachment stored in the platform, transfers the contents of the attachment to the SFTP server. The component returns a summary of the written file.

  3. Delete file
    Action to delete file by provided full file path.

  4. Download file by name
    Finds a file by name in the provided directory and uploads (streams) to the attachment storage (a.k.a. steward).

  5. Download files
    Finds a file by criterias in the provided directory and uploads (streams) to the attachment storage (a.k.a. steward).

  6. Move File
    Action to move file on SFTP already exists in one location on an sftp server to be moved to another location on the same SFTP server. Target location MUST exist.

Known limitations

  • The maximum file size accepted by the SFTP component is limited to 100 MB.
  • The attachments mechanism does not work with Local Agent Installation
  • Get new and updated files trigger mechanism is based on SFTP file modifyTime metadata field. For correct processing the trigger requires correct time configuration on the SFTP server.
  • Get new and updated files trigger does not support empty files processing.
  • Get new and updated files trigger does not support fetch page Emit Behaviour

The SFTP component uses ssh2-sftp-client.

Explanation of Unix file types

Get your free 14-day trial account to use this component.