FTP Connector

FTP (File Transfer Protocol) is a standard network protocol for transferring files between a client and server. This component allows uploading, downloading, moving, and deleting files on an FTP or FTPS server.

Connections

Basic Authentication

Authenticate using username and password.

This component supports basic authentication, meaning that a username and password can be entered for authentication, or if the FTP server allows anonymous access, those values can be left blank.

Prerequisites

• An FTP or FTPS server with accessible credentials
• Server hostname or IP address
• Port number (typically 21 for FTP or 990 for FTPS)
• SSL/TLS configuration details (if using FTPS)

Configure the Connection

Create a connection of type Basic Authentication and configure the following:

• Username: Enter the FTP username (leave blank for anonymous access)
• Password: Enter the FTP password (leave blank for anonymous access)
• Host: Enter either an IP address (e.g. 1.2.3.4) or FQDN (e.g. ftp.example.com) for the FTP server's host name
• Port: Most FTP servers run on port 21 and most FTPS (secure) servers run on port 990, though ports are configurable and server administrators can choose to operate on different ports
• Secure: Some FTP servers use FTPS rather than plain FTP. For plain, unsecured FTP, select false (though encrypting the connection is recommended if possible). If the FTP server uses SSL/TLS, select true for explicit FTPS or implicit for implicit FTPS. For information on implicit and explicit FTPS, see this documentation

If the connection fails, verify the hostname, port and security information with the server administrator.

Input	Comments	Default
Username	The username for FTP authentication.
Password	The password for FTP authentication.
Host	The address of the FTP server. This should be an IP address or hostname.
Port	The port of the FTP server. Default is 21 for FTP or 990 for implicit FTPS.	21
Secure	Whether to use FTPS over TLS. Set to 'true' for explicit FTPS, 'false' for plain FTP, or 'implicit' for legacy implicit FTPS.	false
Ignore SSL Errors	When true, ignores SSL certificate validation errors such as self-signed certificates.	false

Triggers

New or Modified Files

Checks for new and modified files in a directory on an FTP server on a configured schedule.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The directory path on the FTP server to monitor for new or modified files.
Pattern	A glob-style pattern to filter files by name. Use wildcards like .csv or report_.txt to match specific file types or naming conventions.	*
Include Subdirectories	When true, recursively monitors files in all subdirectories. When false, only monitors files in the specified directory.	false

Actions

Create Directory

Creates a new directory. When Include Subfolders is enabled, recursively creates any missing directories in the path.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The directory path on the FTP server to monitor for new or modified files.
Include Subfolders	When true, recursively creates any missing directories in the path.	true

Delete File

Deletes a file from an FTP server.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The full path of the file on the FTP server to delete.

List Directory

Lists the contents of a directory.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The full path of the directory on the FTP server to list.

Move File

Moves a file on an FTP server.

Input	Comments	Default
Connection	The FTP connection to use.
Source Path	The current path of the file on the FTP server to move.
Destination Path	The new path where the file will be moved on the FTP server.

Read File

Reads a file from an FTP server.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The full path of the file on the FTP server to read.
Return Buffer	When true, treats the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8.	false

Write File

Writes a file to an FTP server.

Input	Comments	Default
Connection	The FTP connection to use.
Path	The full path on the FTP server where the file will be written.
Data	The text or binary data to write to the file on the FTP server.