Skip to main content
Go to the Studio
SFTP

SFTP - Connect

SFTP - Connect

Establishes a secure connection to an SFTP (SSH File Transfer Protocol) server that every other action of the group will use. It supports authentication by user and password, by private key or by both combined, and offers advanced timeout and keep-alive options for unstable networks.


Options​

Host​

Enter the address of the SFTP server, which can be a domain or an IP address. Example: sftp.servidor.com.

Port​

Enter the connection port of the SFTP server. The default port for SFTP is 22.

User​

Enter the user name for authenticating on the server. This field is optional in setups that use only a private key.

Password​

Enter the password for accessing the server. This field is optional when authentication is done by private key.

Path to the private key​

Enter the full path of the private key file on the local computer, for SSH key authentication. This field is optional when authentication is done by user and password.

Passphrase​

Enter the passphrase used to decrypt the private key, when it is protected. This field is optional and can only be used together with the Path to the private key.

Connection timeout​

Enter the maximum wait time, in milliseconds, for the connection to be established. This field is optional.

Keep-alive interval​

Enter the interval, in milliseconds, for sending keep-alive packets, keeping the connection active during idle periods. This field is optional.

Returns​

This action has no direct returns. Its ID is used as a reference by the other SFTP actions that need an active connection.

Rules and Conditions​

  • The Host and Port fields are required.
  • At least one authentication method must be given: user and password, or a private key.
  • The Passphrase can only be used when the Path to the private key is filled in too.
  • This action must run before any other SFTP action in the flow.
  • At the end of the flow, use SFTP: Disconnect to release the connection resources.