Get FTP file
Description
Looks up a single file or directory on an FTP/SFTP server by path and returns it as an FTP file object. A missing path is not an error: the returned object has exists = false so the flag can be branched on. The error branch is taken only for connection or protocol failures.
When to use
Use Get FTP file when you already know the exact path of a single file or directory and just need to check it or read its metadata, rather than searching a directory with Find FTP files. A missing path is deliberately not treated as an error: the node still takes the Success pin, but the returned object has exists set to false (name and path are filled in; size, modified, and type are unset). Break the object and branch on exists to tell “doesn’t exist” apart from a real failure. The Error pin only fires for connection or protocol failures — a bad host, failed authentication, or a dropped session. Feed the result straight into Open, Remove, or Move FTP file when exists is true — they read the server connection from the file object itself, no separate Credentials needed.
Pins
Input pins
| Pin | Type | Default | Notes |
|---|---|---|---|
| Credentials | FTP credentials | — | FTP credentials produced by an FTP credentials node. |
| Path | string | — | Path of the file or directory to look up. Format follows the server's conventions. |
Output pins
| Pin | Type | Notes |
|---|---|---|
| File | FTP file | The looked-up entry. Break the object and check its exists field before trusting name, path, size, modified time, or type — a missing path still takes this Success pin with exists set to false. |
Execution pins
| Pin | Direction |
|---|---|
| In | Input |
| Success | Output |
| Error | Output |
Example
Skip processing if an expected file hasn’t arrived yet. Wire FTP
username/password credentials (Protocol SFTP) into Get FTP file, set Path
to /inbox/orders.csv, then on Success break the File output and wire its
exists field into a Branch node. On True, pass the same File value into
Open FTP file to read the stream; on False, log a message and stop, or
retry later. Wire the Error pin to a Log message so connection failures
are distinguished from a simply-missing file.