SFTP

Description

Read and write files or directories to/from SFTP servers

Component key: sftp

Authorization Methods

SFTP requires one of the following authorization methods.

KeyNameDescription
basicBasic AuthBasic authorization using a username/password combination
private_keyPrivate KeyPrivate Key authorization based on a username/private key combination

Actions

Delete File

Delete a file from a SFTP server

Action key: deleteFile

Inputs

KeyTypeDefaultRequiredComments
hostSTRINGNoneTrueSFTP server IP or hostname
pathSTRINGNoneTruePath of file to delete (e.g. /path/to/file.txt)
portSTRINGNoneFalseSFTP server port (defaults to port 22)

Move File

Move a file on an SFTP server

Action key: moveFile

Inputs

KeyTypeDefaultRequiredComments
destinationPathSTRINGNoneTruePath of file to move (e.g. /my/destination/path.txt)
hostSTRINGNoneTrueSFTP server IP or hostname
portSTRINGNoneFalseSFTP server port (defaults to port 22)
sourcePathSTRINGNoneTruePath of file to move (e.g. /my/starting/path.txt)

Read File

Read a file from SFTP

Action key: readFile

Inputs

KeyTypeDefaultRequiredComments
hostSTRINGNoneTrueSFTP server IP or hostname
inputPathSTRINGNoneTruePath of file on SFTP server to read data from (e.g. /path/to/my/file.txt)
portSTRINGNoneFalseSFTP server port (defaults to port 22)

Write File

Write a file to SFTP

Action key: writeFile

Inputs

KeyTypeDefaultRequiredComments
dataTEXTNoneTrueText to write into the file
hostSTRINGNoneTrueSFTP server IP or hostname
outputPathSTRINGNoneTruePath on SFTP server to write file (e.g. /i/love/commas.csv)
portSTRINGNoneFalseSFTP server port (defaults to port 22)
Last updated on