Skip to main content

SFTP - Download Files to Shipyard

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_PORTIntegerβœ…"22"-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.
RSA Key FileSFTP_RSA_KEY_FILEAlphanumericβž–--The file name of an RSA key you would like to use for authentication. Typically downloaded to Shipyard in a previous step.
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_TYPESelectβœ…exact_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.
Shipyard Folder NameSFTP_DESTINATION_FOLDER_NAMEAlphanumericβž–--Folder where the file(s) should be downloaded. Leaving blank will place the file in the home directory.
Shipyard File NameSFTP_DESTINATION_FILE_NAMEAlphanumericβž–--What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: SFTP - Download Files to Shipyard
inputs:
SFTP_HOST: null ## REQUIRED
SFTP_PORT: '22' ## REQUIRED
SFTP_USERNAME: null
SFTP_PASSWORD: null
SFTP_RSA_KEY_FILE: null
SFTP_SOURCE_FOLDER_NAME: null
SFTP_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
SFTP_SOURCE_FILE_NAME: null ## REQUIRED
SFTP_DESTINATION_FOLDER_NAME: null
SFTP_DESTINATION_FILE_NAME: null
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'