Skip to main content
Let’s learn how to connect Engini to SFTP. SFTP stands for SSH File Transfer Protocol. It transfers files between a server and a client over Secure Shell (SSH), which encrypts all data, including your username and password. This integration lets you list, read, upload, move, rename and delete files and folders on your SFTP server, and start workflows when new files or subfolders appear. To get started, make sure you have the details of your SFTP server and an account on it.

Add a Connection to SFTP in Engini

Prerequisites

  • An SFTP server that Engini can reach, and its host name or IP address.
  • A username, and either a password or a private key, for an account on that server.

Connecting Engini to SFTP

  1. Enter your Engini account at https://app.engini.io.
  2. Navigate to the Connections page by clicking on Connections in the left sidebar or by clicking here. Engini - Connections page
  3. Click on the “New Integration” option located at the top bar. Engini - New Integration button
  4. Choose the SFTP option from the available applications. SFTP - Choose Application
  5. Enter the following details in the “New Integration” form and press Save:
Note: There are two different authentication methods available, and the required fields differ depending on the option you choose. Please follow the relevant instructions based on your selected method.

Password

SFTP - New Integration form, Password
  1. Connection Name - Enter a name that helps identify the SFTP connection.
  2. Host - Enter the host name or IP address of your SFTP server, for example sftp.example.com.
  3. Port - Enter the port your SFTP server listens on. The default is 22.
  4. Authentication Method - Select Password.
  5. Username - Enter the login name of your SFTP account.
  6. Password - Enter the password of your SFTP account.
  7. Save - Click Save to create the connection.

Private Key

SFTP - New Integration form, Private Key
  1. Connection Name - Enter a name that helps identify the SFTP connection.
  2. Host - Enter the host name or IP address of your SFTP server, for example sftp.example.com.
  3. Port - Enter the port your SFTP server listens on. The default is 22.
  4. Authentication Method - Select Private Key.
  5. Username - Enter the login name of your SFTP account.
  6. Private Key - Enter the text of your private key, in PEM format.
  7. Private Key Passphrase - If your private key is protected by a passphrase, enter it here. Leave it empty if the key has no passphrase.
  8. Save - Click Save to create the connection.

Triggers

Check for New Files

Checks a folder on your SFTP server on a schedule and starts the workflow for each new file it finds. SFTP - Check for New Files trigger
  1. Folder - Enter the path of the folder to check, for example /incoming. The default is /, the root folder.
  2. Starting (UTC) - Select the start date and time for the scheduled trigger.
  3. Recur every - Choose the time interval for triggering and checking files. The minimum time interval is 15 minutes.
  4. Add time frame - You can specify a time frame during which the trigger will operate.
  5. Add Conditions - Click Add Conditions to define conditions that narrow down the data list and return only the relevant items. To learn more about using filters, click here.
Each new file is passed to the next steps with these properties: Name, Size (bytes), Last Modified, Permissions, Type (File or Directory) and Is Directory.

Check for New Subfolders

Checks a folder on your SFTP server on a schedule and starts the workflow for each new subfolder it finds. SFTP - Check for New Subfolders trigger
  1. Folder - Enter the path of the folder to check, for example /incoming. The default is /, the root folder.
  2. Starting (UTC) - Select the start date and time for the scheduled trigger.
  3. Recur every - Choose the time interval for triggering and checking subfolders. The minimum time interval is 15 minutes.
  4. Add time frame - You can specify a time frame during which the trigger will operate.
  5. Add Conditions - Click Add Conditions to define conditions that narrow down the data list and return only the relevant items. To learn more about using filters, click here.
Each new subfolder is passed to the next steps with these properties: Name, Size (bytes), Last Modified, Permissions, Type (File or Directory) and Is Directory. Note: A folder’s modified time also changes when something inside it is added or removed, so an existing subfolder can occasionally start the workflow again.

Actions

Append to File

Adds content to the end of an existing file on your SFTP server. SFTP - Append to File action
  1. Remote folder path - Enter the path of the folder that holds the file, for example /home/user.
  2. File name - Enter the name of the file to append to, for example logfile.txt.
  3. Content to append - Enter the text to add to the end of the file, or the file as a base64 string. You can map it from a previous step.
  4. File type - Select how the file is handled: Auto Detect, Text or Binary.

Change File Permissions

Changes the permissions of a file on your SFTP server. SFTP - Change File Permissions action
  1. File Path - Enter the full path of the file, for example /home/user/file.txt.
  2. Permissions - Enter the new permissions as a numeric mode, for example 644.

Create Folder

Creates a new folder on your SFTP server. SFTP - Create Folder action
  1. Parent folder path - Enter the path of the folder in which to create the new folder, for example /home/user.
  2. New folder name - Enter the name of the new folder, for example archive.

Delete File

Deletes a file from your SFTP server. SFTP - Delete File action
  1. Folder path - Enter the path of the folder that holds the file, for example /home/user.
  2. File name - Enter the name of the file to delete, for example report.csv.

Delete Folder

Deletes a folder from your SFTP server. SFTP - Delete Folder action
  • Folder path - Enter the path of the folder to delete, for example /home/user/old.

Get File

Retrieves a file from your SFTP server, including its content. SFTP - Get File action
  1. File path - Enter the full path of the file, for example /home/user/file.txt.
  2. File type - Select how the file is handled: Auto Detect, Text or Binary.
  3. Encoding - Select the text encoding used to read the file. This applies to text files. The default is Unicode (UTF-8).

Get Folder Content

Retrieves the list of items in a folder on your SFTP server. SFTP - Get Folder Content action
  1. Folder path - Enter the path of the folder. The default is /, the root folder.
  2. Content type - Choose what to return: Files and Folders, Files, or Folders. The default is Files and Folders.

Move File

Moves a file to another folder on your SFTP server. SFTP - Move File action
  1. Source path - Enter the path of the folder that holds the file, for example /home/user.
  2. File name - Enter the name of the file to move, for example report.csv.
  3. Destination path - Enter the path of the folder to move the file to, for example /home/user/archive.

Rename File

Renames a file on your SFTP server. SFTP - Rename File action
  1. Folder path - Enter the path of the folder that holds the file, for example /home/user.
  2. File name - Enter the current name of the file, for example report.csv.
  3. Rename to - Enter the new name of the file, for example report-final.csv.

Rename Folder

Renames a folder on your SFTP server. SFTP - Rename Folder action
  1. Current folder path - Enter the path of the folder to rename, for example /home/user/old.
  2. New folder name/path - Enter the new name of the folder, for example archive.

Upload File

Uploads a file to your SFTP server. SFTP - Upload File action
  1. Remote folder path - Enter the path of the folder to upload the file to, for example /home/user/uploads.
  2. File name - Enter the name for the uploaded file, for example document.txt.
  3. File content - Enter the text of the file, or the file as a base64 string. You can map it from a previous step.
  4. File type - Select how the file is handled: Auto Detect, Text or Binary.