SFTP - Delete Files

Overview

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

This Template requires write permissions in order to remove objects from the SFTP server.

Variables

Name	Reference	Type	Required	Default	Options	Description
Host	SFTP_HOST	Alphanumeric	✅	None	-	The domain or the IP address of the SFTP Server you want to connect to.
Port	SFTP_PORT	Integer	✅	22	-	Number for the port to connect to. `22` is used by default.
Username	SFTP_USERNAME	Alphanumeric	➖	None	-	Value of the configured username in the SFTP server. Can be left blank if the RSA Key is provided
Password	SFTP_PASSWORD	Password	➖	None	-	Value of the configured password associated to the username on the SFTP server. Can be left blank if the RSA Key file is provided
RSA Key File	SFTP_RSK_KEY	Alphanumeric	➖	None	-	The private key file used to authenticate via ssh into the SFTP server. Can be used in place of the Username and Password.
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	➖	None	-	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	✅	None	-	Name of the target file in the SFTP server. Can be regex if "Match Type" is set accordingly.

YAML

Below is the YAML template

YAML


source:
  template: SFTP - Delete Files
  inputs:
    SFTP_HOST:
    SFTP_PORT: '22'
    SFTP_USERNAME:
    SFTP_PASSWORD:
    SFTP_RSK_KEY:
    SFTP_SOURCE_FILE_NAME_MATCH_TYPE: exact_match
    SFTP_SOURCE_FOLDER_NAME:
    SFTP_SOURCE_FILE_NAME:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 100
    - 200
    - 202
    - 207
    - 210