SFTP Connection in Console

Brief Overview

Integrate with an SFTP server to securely transfer data for reports, user imports, or automated workflows. Follow these steps to connect your SFTP storage.

How It Works

SFTP connections page overview

The SFTP Connections page is a central hub for viewing and managing all of your configured SFTP connections.

1. SFTP table

The SFTP connections table lists all configured connections.

Table columns:

13. Connection ID: Unique identifier for the connection

14. Connection name: Custom name given to the connection

15. Authentication method: Type of authentication used

16. Host: Server address for the SFTP connection

17. Port: Network port used to connect (default is 22)

18. Username: Login credential used to authenticate with the SFTP server

19. Created by: User who created the connection

20. Last modified by: User who last updated the connection

2. Table icons

Manage columns

Remove or add columns from the table

1. Click the Manage columns icon

2. Select which columns you'd like to have in the table

3. Click Apply

Add new connection

1. Click the + Add New Connection button to add a new SFTP connection

Export connections

1. Click the Export Connections icon to download a csv or xlsx file containing all configured connection details

Search

1. Use the Search bar to quickly find specific connections

Item options

Available actions:

1. Click the Edit icon to update the connection

2. Click the Delete icon to remove the connection

How to setup a SFTP connection

You can add a new connection whether it's your first or you're adding to existing ones.

1. Choose how to start:

   1. If this is your first connection:

      1. Go to the Available connections tab

      2. Hover over the SFTP tile

      3. Click Setup

   2. If you already have connections:

      1. Go to the Active connections tab

      2. Hover over the SFTP tile

      3. Click Manage Connections

      4. A table will open showing all configured connections for that integration

      5. Click Add new connection

2. You'll be taken to the Add SFTP connection page

3. Give your connection a clear, descriptive name so you can easily recognize it later

   1. For example: SFTP_Weekly_Export

4. Enter the host name

   1. This is the server address (host name or IP)

   2. For example: sftp.mycompany.com

5. Enter the SFTP port

6. Enter the username used to log in to the SFTP server

7. Optional: Enter a directory path

   1. This is a subfolder path within your SFTP user folder to organize your files

      1. For example: WalkMe/all-unique-users

8. Select an authentication method from the dropdown that matches your security and access setup:

   1.  SFTP Credentials: Enter the password for the username above

      1. This method is commonly used for simple or testing environments

   2. SFTP Public Key: Use an SSH key pair for secure authentication

      1. Encryption Algorithm: The type of encryption your public key uses

         1. For example: RSA, ECDSA)

      2. Public Key: Your public SSH key in OpenSSH format

         1. The public key must be installed on the server in the M authorized_keys file.

9. Click Test Connection to validate that your connection works

   1. If the test is successful, you'll see a confirmation message

   2. If there's an issue, you'll get an error message with steps to fix it

10. Click Save