/
SFTP

SFTP

Owned by wiki
Last updated: Jul 31, 2023
4 min read

Connect To SFTP V2

This activity connects to the specified SFTP Server.

Activity Parameters

The Connect toS FTP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Certificate Content (text box editor type) (type: string): the content of the authentication certificate (OpenSSH, SSH Type).

  • Certificate Path (text box editor type) (type: string): the path of the authentication certificate (OpenSSH, SSH Type).

  • Hostname / IP Address (text box editor type) (type: string): the DNS name or IP address of the SFTP host.

  • Passphrase (text box editor type) (type: string): the passphrase for the selected certificate.

  • Passphrase Binding (text box editor type) (type: string): bind to a variable containing the encrypted passphrase for the certificate host. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).

  • Password (text box editor type) (type: string): the password for the provided username.

  • Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the SFTP host. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).

  • SFTP Port (text box editor type) (type: int32): the SFTP port.

  • SFTP Timeout (text box editor type) (type: int32): the SFP timeout (default 60 seconds).

  • Username (text box editor type) (type: string): the username connect to the SFTP host.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: object): outputs a SFTP connection. The output of this activity should be used as Input for all Connection parameters used for all activities placed under SFTP category.

Disconnect from SFTP

This activity close the connection to the specified SFTP Server.

Activity Parameters

The Disconnect to SFTP activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Input (type: object): SFTP connection object

SFTP Download

This activity can download a single file or a folder from an sftp server.

Activity Parameters

The SFTP Download activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • SFTP Connection (text box editor type) (type: object): connection object to the sftp server from the output of the connect to sftp server activity.

  • File or Folder download (dropdown type) (type: string): Select file for file download and folder, if you want to download a folder

  • Local Folder Path (text box editor type) (type: string): Target location.

  • Remote file / folder Path (text box editor type) (type: string): Download source. Path to the source file or folder.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: List<string>t): outputs a SFTP connection. The output of this activity should be used as Input for all Connection parameters used for all activities placed under SFTP category.

SFTP List Files and Folders

This activity return a list of files and folders on the sftp server.

Activity Parameters

The SFTP List Files and Folders activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • SFTP Connection (text box editor type) (type: object): connection object to the sftp server from the output of the connect to sftp server activity.

  • Remote file / folder Path (text box editor type) (type: string): Remote location.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output Fullnames (type: List<string>): Outputs a simple list of all files and folders with there fullnames (including the path)

  • Output Names (type: List<string>): Outputs a simple list of all files and folders with the names (without path)

  • Output Names with type (type: Dictionary<string,string>): outputs a dictionory where the key is the name of the file or foldername and the value is the type file or folder

  • Output Result Code (type: int32): output the result code of the execution. 0 = OK, 1 NOK

SFTP Upload

This activity uploads files and folder to an sftp server.

Activity Parameters

The SFTP Upload activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • SFTP Connection (text box editor type) (type: object): connection object to the sftp server from the output of the connect to sftp server activity.

  • Local Folder Path (text box editor type) (type: string): Soruce location of the file or folder which needs to be uploaded.

  • Remote file / folder Path (text box editor type) (type: string): Dtarget folder for the upload

The Read Only Output variable are the possible output values that the activity will provide:

  • Output (type: List<string>): Outputs a simple list of all files and folders which where uploaded.

  • Output Result Code (type: int32): output the result code of the execution. 0 = OK, 1 NOK

Related content