List Remote Files SFTP/FTP
- 21 Mar 2024
- 1 Minute to read
- Print
- DarkLight
List Remote Files SFTP/FTP
- Updated on 21 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
| Step Details | |
| Introduced in Version | 4.0.0 |
| Modified in Version | 8.19.0 |
| Location | Integration > FTP |
The List Files by FTP component calls an FTP (File Transfer Protocol) server to retrieve the files stored in a defined remote folder location. This step returns an array of file data with the files stored in the defined folder.
Note: All Certificates and related information for FTP/SFTP steps are stored within the Flow Step and are not stored independently in the database or the server.
Properties
FTP/SFTP
| Property | Description | Data Type | ||||
|---|---|---|---|---|---|---|
| Pattern (Only in v8.19+) | The pattern will set file names that will be included in the result set. ? matches any single character. * matches any number of any characters except the directory separators. ** matches any characters and separators. | --- | ||||
| Get Configuration From Data | Allows the user to set the configuration as input fields | --- | ||||
| Server | ||||||
| Host | Host name of the FTP server | --- | ||||
| Port | Port of the FTP server | --- | ||||
| SSL | Enables user to select an SSL Security Type | --- | ||||
| SSL Security Type | Choose the security type as Explicit, Unsecure, Implicit, or Secure. | --- | ||||
| Authentication | ||||||
| Use Certificate for Auth | Enables users to use a Certificate and Certificate Password for authentication for FTP. Users can use the following types of certificates - X.509, PFX/PKCS#12, and PEM. | --- | ||||
| Username | Username for the FTP account | --- | ||||
| Password | Password for the FTP account | --- | ||||
| Proxy | ||||||
| Type | Allows the user to select the Proxy type | --- | ||||
| Advanced | ||||||
| Enable Compression | Enables compression of the file being uploaded | --- | ||||
Inputs
| Property | Description | Data Type |
|---|---|---|
| Remote File Path | The FTP/SFTP directory path of the FTP/SFTP host | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Files | The array of file data of the files stored in the defined folder. | List of FTPFileInfo |
Step Changes
| DT Title | Description | Version | Date |
|---|---|---|---|
| [DT-037229] SSL Security Type drop-down does not display | Added a new "SSL Security Type" setting for the FTP steps. | 8.11 | April 2023 |
| [DT-040615] FR - Filter by File Pattern at SFTP Server | Added in the "Pattern" setting for SFTP and FTP steps. | 8.19 | March 27, 2024 |
Related Information
Forum Posts:
FTP File Download Update Upload Flow
Download SFTP File - Remote File Path
Access SFTP Folder Using SSH Keys
Was this article helpful?
