FlowPro Docs
  • What is FlowPro?
  • Guides
    • Installing FlowPro
    • Creating your first script
    • Managing Settings
    • Exporting a script
    • Environment and World
    • System Variables
    • Examples and Samples
      • Simple Calculator
    • Extras
      • Readme
      • Audit Check
  • FlowBlocks
    • Common terms
    • General
      • Start
      • End Block
      • Comment
      • Variable
      • File Function
      • Include File
      • Wait a little
      • Bulk Assign
      • Open a File
      • Unique String ID
      • Play a File
      • Break Execution
      • Parse Markdown
      • Parse String as Object
    • Builder
      • Form Settings
      • Readme
      • Render Label
      • User Simple Input
      • User Simple Input (2)
      • User Long Text Input
      • User Simple Number Input
      • User Dropdown
      • User Checkbox
      • User Date Input
      • User Date/Time Input
      • User Time Input
      • User Filename Input
      • User Button Action
      • User Button Build Form
      • Clear Form
      • View
    • Inputs
      • Short Text Input
      • Long Text Input
      • Numerical Input
      • Fetch as HTML/Json
      • Read Excel as Array
      • Read XML file
      • Parse XML Data
      • Read File As String
      • Read Dir
    • Output
      • Send Email
      • Save to Excel
      • Write to file
      • Pipe Output
      • Output in Window
      • Echo Message
      • Output Results to View
      • Display Data Table
      • Print World
    • Arrays and Objects
      • Filter an Array
      • Get Value by index
      • Get Value by key
      • Create an Object
      • Unpackage Object/Array
      • Create an Array
      • Array Push
      • Add to object
      • Object/Array Length
    • Strings
      • Split Text
      • Find and Replace
      • Character Count
      • String Length
      • Prepend / Append
      • Concat
      • Concat and Assign
      • Right Trim
      • Left Trim
      • Trim
      • To Lowercase
      • To Uppercase
      • Left (Before String)
      • Right (Before String)
      • Matches by Regex
      • Split Text By Line
      • To String
      • Line Break
      • Join Strings
      • Template String
    • Loops
      • Loop by number
      • Loop by Input
      • End Loop
      • While Do
    • Conditionals
      • If Do
      • If Else
      • If Null
      • If Not Null
      • If Exists in World
      • Multiple IF Do
      • If String Contains
      • End If
    • Numeric
      • Add Values
      • Subtract Values
      • Multiply values
      • Divide Values
      • Sum of Numbers
      • Round Number
      • Ceil
      • Random Number
      • Increment Number
      • Decrement Number
      • Modulus
    • Math
      • POW
      • Math.Ceil
      • Square Root
      • Sin
      • Cos
      • PI
      • Math Constants
    • HTML
      • Paragraph
      • Create Simple HTML Table
      • ImageListView Widget
      • Display Data Table
    • Files
      • Read File
      • File Base Name
      • IF File Exists
      • IF Path is File
      • IF Path is directory
      • Copy File
      • Move File
      • File Attributes
      • Create a Folder
    • Commands
      • Basic Command
      • Long Command
    • Database
      • MySQL Query
      • MySQL Query with Params
      • SQL Server
      • SQLITE Query
    • File Transfer
      • FTP Upload
      • FTP Download
      • FTP List Files
      • SFTP List Files
      • SFTP Upload
      • SFTP Download
  • Use Cases
    • For Programmers
      • Connection to an API
    • For the Office
      • Creating an Simple Report
  • Extras
    • Special Variables
    • Keyboard Shortcuts
Powered by GitBook
On this page
  • Description
  • Properties
  • Returns
  • NPM
  1. FlowBlocks
  2. File Transfer

SFTP List Files

SFTP list files block

PreviousFTP List FilesNextSFTP Upload

Last updated 3 years ago

Description

List files from a directory once connected to a SFTP server

Properties

Connection Settings

The connection settings to connect to the SFTP server

// Sample Connection String
host=127.0.0.1&username=auser&password=apassword

Available Settings

  • host (url or ip address)

  • username ( username for the SFTP account)

  • password (password for the SFTP account)

  • port (port to connect to. Default is 22)

More connection settings options can be found at

Remote Path

The remote path of the directory you want to list

Returns

An array of objects and file paths with access rights

NPM

This block uses ssh2-ftp-client from npm. ()

https://www.npmjs.com/package/ssh2-sftp-client
https://www.npmjs.com/package/ssh2-sftp-client