Connect to FTP/FTPS/SFTP Server | FTPS
Connects to an FTP server. Allows for uploading, downloading and renaming documents.
Properties
Connection URL ${}
connectionUrl
The url address where the remote FTP service is hosted.
Directory or File Path ${}
path
The relative location of the file or directory on the FTP server
Move File to Directory ${}
movePath
The relative location where the file or directory will be moved to.
Command
action
The FTP command to run on the remote FTP server.
| valid options | |
|---|---|
| Download File DOWNLOAD | Download the file resource located at the supplied path and named by ftp_fileName. |
| Upload File UPLOAD | Upload a document to the FTP server where it will be placed at the supplied path and will be named as declared by ftp_fileName. |
| List Files LIST | List all the files in the directory at the supplied path |
| Move or Rename File MOVE | Move or rename a file at the supplied path to the ftp_movePath value. If the paths are in the same directory, the file will effectively be renamed to the value supplied in ftp_moveFileName instead of moved. |
| Delete File DELETE | Delete the file or directory at the supplied path. This action cannot be undone. |
Remote File Name ${}
fileName
The name of the file resource to act upon.
New File Name ${}
moveFileName
The new name of the file. Used with MOVE action.
File Contents ${}
uploadTemplate
The file contents that will be uploaded to the remote FTP server. Accepts template syntax.
Results Namespace
downloadNamespace
The key that will contain the data of the file contents that were downloaded from the remote FTP server.
Record Identifier Template ${}
identifier
Searchable template used to help identify the FTP action in the outbound call logs. Please set this to make your logs easier to interpret.
Use SSH Certificate
useCertificate
When enabled an SSH certificate will be used to authenticate with the remote SFTP server.
SSH Private Key
projectSecretId
When use of a certificate is enabled, identifies the certificate to be used. Certificates are configured in the project settings interface as "Project Secrets".
Skip Certificate Validation
acceptCertificate
When enabled, normal validation of the remote certificate on an FTPS is disabled and is accepted. This option should be avoided for security reasons, but exists to allow connection to FPTS servers that may not be configured optimally.