FTP username/password credentials

I/O and network Pure
FTP username/password credentials
Host
Credentials(FTP credentials)
Port
Username
Password
Protocol(enum(FtpProtocol)) FTP

Description

Pure function: builds an FTP credentials object from a host, port, username, password, and protocol (FTP, FTPS_EXPLICIT, FTPS_IMPLICIT, or SFTP). Wire the credentials output into any FTP operation node. A port of 0 selects the protocol default (21 for FTP/FTPS_EXPLICIT, 990 for FTPS_IMPLICIT, 22 for SFTP).

When to use

Use FTP username/password credentials to authenticate against an FTP, FTPS, or SFTP server using a username and password. Because it is a pure node, the session is opened lazily when the credentials are consumed. Wire the output directly into the Credentials input of Find FTP files or Get FTP file — those are the only two FTP nodes with a Credentials input. Every file object they return already carries its originating connection, so Open, Remove, and Move FTP file take that file object instead and need no credentials of their own. SSH key authentication is not yet supported — use a username and password for SFTP as well for now.

Pins

Input pins

Pin Type Default Notes
Host string — Hostname or IP address of the FTP/SFTP server.
Port integer — Server port. Set to 0 to use the protocol default (21 for FTP and FTPS_EXPLICIT, 990 for FTPS_IMPLICIT, 22 for SFTP).
Username string — Account username on the FTP/SFTP server.
Password string — Account password. Store sensitive values as pipeline variables rather than hardcoding them.
Protocol enum(FtpProtocol) FTP Wire protocol: FTP (plain), FTPS_EXPLICIT (AUTH TLS upgrade), FTPS_IMPLICIT (TLS from the start, usually port 990), or SFTP (SSH file transfer).

Output pins

Pin Type Notes
Credentials FTP credentials A credentials object carrying the server location and login. Wire directly into Find FTP files or Get FTP file — the file objects those nodes return then carry the connection onward to Open, Remove, and Move FTP file.

Example

Download a file from an SFTP server. Set Host to the server hostname, Username and Password to a valid account, Protocol to SFTP, and leave Port at 0 to use the default of 22. Wire the Credentials output into Get FTP file’s Credentials input and set its Path to the file you want to read. On Success, pass the File output straight into Open FTP file, then pipe the resulting stream through Stream to string and log the contents.

See also