Skip to main content

SFTP - Download Files

Overview

Quickly export one or more files from an SFTP Server. The match type selected greatly affects how this Blueprint works.

This Blueprint requires read permissions in order to download from the SFTP server.

Variables

NameReferenceTypeRequiredDefaultOptionsDescription
HostSFTP_HOSTAlphanumeric--Domain or IP address of the SFTP server to connect to.
PortSFTP_PORTInteger22-Number for the port to connect to. 22 is used by default.
UsernameSFTP_USERNAMEAlphanumeric--Value of the configured username in the SFTP server.
PasswordSFTP_PASSWORDPassword--Value of the configured password associated to the username on the SFTP server.
SFTP Folder NameSFTP_SOURCE_FOLDER_NAMEAlphanumeric--Name of the folder where the file is stored in the SFTP server.
SFTP File Name Match TypeSFTP_SOURCE_FILE_NAME_MATCH_TYPESelectexact_matchExact Match: exact_match

Regex Match: regex_match
Determines if the text in "SFTP File Name" will look for one file with exact match, or multiple files using regex.
SFTP File NameSFTP_SOURCE_FILE_NAMEAlphanumeric--Name of the target file in the SFTP server. Can be regex if "Match Type" is set accordingly.
Local Folder NameSFTP_DESTINATION_FOLDER_NAMEAlphanumeric--Folder where the file(s) should be downloaded. Leaving blank will place the file in the home directory.
Local File NameSFTP_DESTINATION_FILE_NAMEAlphanumeric--What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).