SFTP Download

SFTP Download

Type: sftp-download  ·  Package: SFTP Activities v1.0.0  ·  Output: string

Download a file from the SFTP server to your machine. To collect files that an external system leaves on the server: reports from a bank, data from a supplier, exchange files.

How it works

Copy the file from remotePath (server) to localPath (your machine, including the name). Returns the local route.

Required parameters

Parameter	Editor	Description
remotePath	expression	Path of the remote file to download.
localPath	expression	Destination local path (with file name).

Optional parameters

Parameter	Editor	Description
session	session	SFTP Connect session. Within a body it is inherited.

Output

Returns a string with the local path of the downloaded file.

Example

Download all CSVs from a remote folder:

SFTP List Directory   remotePath = "/salida"   pattern = "*.csv"   → output: archivos
For Each   items = = archivos   itemVariable = item
 └─ activities:
      SFTP Download   remotePath = = item["fullName"]   localPath = = pathJoin("C:/descargas", item["name"])

Related activities

• SFTP List Directory — know what files are available for download.
• SFTP Upload — the reverse operation.