Lists files in a remote SFTP directory when the flow runs. Use to poll secure inboxes and drive Iterator loops over each file.
Lists files in a remote SFTP directory when the flow runs. Use to poll secure inboxes and drive Iterator loops over each file.
When the flow reaches this step, JOrchestrator executes SFTP List against your linked site or an external integration, using the field values you set on General and Design. Downstream steps can read the output payload fields defined for this node.
SFTP List is a action step in the Connectors › SFTP group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.
Typical reasons teams add SFTP List to a flow:
Common patterns on the canvas:
Enter host, credentials, and optional remote directory on the Design tab.
Returns files[] and names[] arrays for downstream Iterator or Match steps.
The designer shows these tabs for this node:
| Tab | Purpose |
|---|---|
| Info | Plain-language description and output payload fields for downstream steps |
| General | Canvas label and read-only node ID |
| AI | Optional assistant to help draft settings from plain language |
| Design | Node-specific configuration fields |
These fields are managed by the designer or runtime — you do not type into them directly:
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
_nodeId | Node ID | node-id | No | — | — |
_payloadFields | Available Fields | payload-panel | No | — | — |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
label | Label | text | No | — | Node label |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
timeoutSeconds | Timeout (seconds) | number (default: 30) | No | — | — |
remotePath | Remote directory | payload-text | No | — | . or /uploads/ Directory to list. Use . for the login directory. |
maxFiles | Max files | select (100 | 500 | 1000 | 2500 | 5000 | 10000; default: 1000) | No | — | — |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
sftpSiteId | SFTP site | sftp-site-select | Yes | — | Required. Choose a site preset saved under Node Configuration → Nodes → SFTP in Joomla or WordPress. |
Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under Node Configuration, not per step on this node. Link the flow to a domain before testing CMS-backed fields.
After this step runs, later nodes can reference these fields using placeholders such as {{sftp_list.success}}.
| Field key | Type | Description |
|---|---|---|
success | boolean | Whether the operation completed successfully. |
host | string | Text value from this node's output. |
remotePath | string | Text value from this node's output. |
count | number | Number of items in the result set. |
files | array | Array of file entries with name, type, size, and date. |
names | array | Flat array of file names in the directory. |
message | string | Human-readable status, error, or result summary. |
Other steps in the same area of the palette:
sftp-delete) — Connectors › SFTPsftp-download) — Connectors › SFTPsftp-upload) — Connectors › SFTP