SFTP - Move or Rename Files

Overview

First time using this Blueprint? Make sure you follow our SFTP authorization guide.

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

This Blueprint requires write permissions in order to move objects from the SFTP server.

Variables

Name	Reference	Type	Required	Default	Options	Description
Host	SFTP_HOST	Alphanumeric	✅	-	-	The domain or the IP address of the FTP Server you want to connect to.
Port	SFTP_PORT	Integer	✅	21	-	Number for the port to connect to. 21 is used by default.
Username	SFTP_USERNAME	Alphanumeric	➖	-	-	Value of the configured username in the FTP server.
Password	SFTP_PASSWORD	Password	➖	-	-	Value of the configured password associated to the username on the FTP server.
SFTP Folder Name	SFTP_SOURCE_FOLDER_NAME	Alphanumeric	➖	-	-	Name of the folder where the file is stored in the SFTP server. If left blank, will look in the root directory.
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 "FTP File Name" will look for one file with exact match, or multiple files using regex.
SFTP File Name	SFTP_SOURCE_FILE_NAME	Alphanumeric	✅	-	-	Name of the target file in the FTP server. Can be regex if "Match Type" is set accordingly.
Destination Folder Name	SFTP_DESTINATION_FOLDER_NAME	Alphanumeric	➖	-	-	The name of the folder where the target file will be moved
Destination File Name	SFTP_DESTINATION_FILE_NAME	Alphanumeric	➖	-	-	Name of the file for the target file once it is moved. If left blank, the original file name will be retained
RSA Key File	SFTP_RSK_KEY	Alphanumeric	➖	-	-	The private key file used to authenticate via ssh into the SFTP server

YAML

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

source:
  blueprint: SFTP - Move or Rename Files
  inputs:
    SFTP_HOST: null ## REQUIRED
    SFTP_PORT: 21 ## REQUIRED
    SFTP_USERNAME: null 
    SFTP_PASSWORD: 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 
    SFTP_RSK_KEY: null 
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0s
  runtime_cutoff: 4h0m0s
  exclude_exit_code_ranges:
    - "3"
    - "200"
    - "201"