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

Name	Reference	Type	Required	Default	Options	Description
Host	SFTP_HOST	Alphanumeric	✅	-	-	Domain or IP address of the SFTP server to connect to.
Port	SFTP_PORT	Integer	✅	`"22"`	-	Number for the port to connect to. `22` is used by default.
Username	SFTP_USERNAME	Alphanumeric	➖	-	-	Value of the configured username in the SFTP server.
Password	SFTP_PASSWORD	Password	➖	-	-	Value of the configured password associated to the username on the SFTP server.
RSA Key File	SFTP_RSA_KEY_FILE	Alphanumeric	➖	-	-	The file name of an RSA key you would like to use for authentication. Typically downloaded to Shipyard in a previous step.
SFTP File Name Match Type	SFTP_SOURCE_FILE_NAME_MATCH_TYPE	Select	✅	`exact_match`	Exact 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 Folder Name	SFTP_SOURCE_FOLDER_NAME	Alphanumeric	➖	-	-	Name of the folder where the file is stored in the SFTP server. Leaving blank will default to the root directory.
SFTP File Name	SFTP_SOURCE_FILE_NAME	Alphanumeric	✅	-	-	Name of the target file in the SFTP server. Can be regex if "Match Type" is set accordingly.
Shipyard Folder Name	SFTP_DESTINATION_FOLDER_NAME	Alphanumeric	➖	-	-	Folder where the file(s) should be downloaded. Name of the folder where the file is stored in the SFTP server. Leaving blank will default to the root directory.
Shipyard File Name	SFTP_DESTINATION_FILE_NAME	Alphanumeric	➖	-	-	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_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
    SFTP_SOURCE_FOLDER_NAME: null
    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:
    - '200'
    - '202'
    - '206'
    - '207'
    - '210'

SFTP - Download Files to Shipyard

Overview​

Variables​

YAML​

Overview

Variables

YAML