SFTP Connections

The SFTP Connections window allows you to configure and manage the SFTP connections used in the available SFTP actions.

SFTP connections support the SSH.NET library version 2024.1.0.

Note: Only users with Owner and Contributor roles can manage SFTP connections.

SFTP Connections window

The window shows the:

  1. Main toolbar: Basic search
  2. SFTP connections list
  3. Bottom toolbar: New connection button

1. Main toolbar

Basic search filter

Select the Lens icon button to search for the SFTP connection by Connection name.

2. SFTP connections list

It shows the SFTP connections that are currently added to the tenant. It displays the following data:

Column Description
Connection name A user-defined label for the SFTP connection.
Host server address The hostname of the SFTP server.
Port number The network port used for the SFTP connection.
User name The username for authenticating to the SFTP server.
Trash can icon The button to delete the SFTP connection. After selecting the button, a dialog appears to ask for confirmation.

Note: All values must be manually entered by the user when creating a new SFTP connection.

3. Bottom toolbar

New connection button

To add a new SFTP connection:

  1. Select the New connection button.
  2. Enter the SFTP connection details:

SFTP add connection window

Field Description
Name Enter a descriptive name for your connection.
Host Enter the hostname of the SFTP server. It is provided by the server administrator or the relevant documentation.
Port Enter the network port used for the SFTP connection. The default SFTP port is 22, but it might vary depending on the server configuration.
User Enter the username for authenticating to the SFTP server. This is assigned by the server administrator and must be known in advance.
Authentication type Select the desired radio button, and fill in the fields:
Password Password Enter the password associated to the User.
SHH private key SHH private key Enter the full contents of the private key file.
SSH private key passphrase For added security, enter the key passphrase if the matching key requires one.

SSH private key authentication

Only OpenSSH formatted keys are allowed. Also make sure that the private key is properly formatted. Missing characters and/or incorrect formatting will result in an error.

SFTP SSH Private Key Authentication

The length of the SSH private key data has been reduced to simplify this example.