Skip to main content

Setting up an SFTP Connection

Set up an SFTP connection in Nexadata with flexible authentication, file path control, and PGP encryption support.

Lourens Kok avatar
Written by Lourens Kok
Updated over 2 months ago

SFTP (Secure File Transfer Protocol) is a widely used method for transferring files securely over SSH. Nexadata supports direct integration with SFTP servers, allowing users to import and export data safely and efficiently.

Here are the key features:

  • Secure Authentication Options: Basic (username and password) or username with private key.

  • Flexible Source Configuration: Specify source directories, file names, and optional PGP encryption keys.

  • Customizable Target Output: Define target directories and file names for exports.

Step-by-Step Instructions

Follow the steps below to create your SFTP connection.

Step 1: Add a Connection

From the Nexadata home screen, click the Create a Connection tile or navigate to Setup β†’ Connections β†’ and select the ⨁ button in the upper right-hand corner.

The Create New Connection form will display.

  • Provide a unique Name for your SFTP connection. Choose a name that clearly identifies the SFTP server within your organization.

  • Select SFTP as the Connection Type.

Step 2: Choose Your Authentication Method

You will need to select one of the two authentication methods:

  • Username and Password: Enter your SFTP username and password.

  • Username and Private Key: Enter your SFTP username and upload your private SSH key.

Note: Private keys must be in a supported format (such as PEM) for successful authentication.

Step 3: Specify Source File Details

Configure how Nexadata will retrieve the source file:

  • Directory Path: Enter the directory where the source file is located.

  • File Name: Specify the name of the file you want to import.

  • PGP Key (Optional): If the source file is encrypted, provide the PGP key to decrypt it during the import process.

Step 4: Specify Target Output File Details

Set up where and how Nexadata will deliver output files:

  • Target Directory Path: Enter the directory where you want the exported file to be saved.

  • Target File Name: Provide the file name for the exported output file.

Tip: Make sure both source and target directories exist and are accessible to your SFTP user account.

Step 5: Submit the Connection

Click the Submit button to finalize the connection setup.

Your SFTP connection should now be active and ready for use in your data pipelines!


Important Notes

  • Make sure your SFTP user account has the correct read/write permissions for the specified directories.

  • Directory traversal is fully supported to manage multi-folder structures.

  • Always secure your private keys and encryption keys according to your organization's security policies.

Did this answer your question?