SFTP
This page contains the setup guide and reference information for the SFTP source connector.
Prerequisites
- The Server with SFTP connection type support
- The Server host
- The Server port
- Username-Password/Public Key Access Rights
Setup guide
Step 1: Set up SFTP
- Use your username/password credential to connect the server.
- Alternatively generate Public Key Access
The following simple steps are required to set up public key authentication:
Key pair is created (typically by the user). This is typically done with ssh-keygen. Private key stays with the user (and only there), while the public key is sent to the server. Typically with the ssh-copy-id utility. Server stores the public key (and "marks" it as authorized). Server will now allow access to anyone who can prove they have the corresponding private key.
Step 2: Set up the SFTP connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, enter the name for the SFTP connector and select SFTP from the Source type dropdown.
- Enter your User Name, Host Address, Port
- Choose the Authentication type Password Authentication or Key Authentication
- Type File type (temporary comma separated)
- Enter Folder Path (Optional) to specify server folder for sync
- Enter File Pattern (Optional). e.g. log-([0-9]{4})([0-9]{2})([0-9]{2}). Write your own regex
- Click on Check Connection to finish configuring the Amplitude source.
Supported sync modes
The SFTP source connector supports the following sync modes:
Feature | Support | Notes |
Full Refresh - Overwrite | ✅ | Warning: this mode deletes all previously synced data in the configured bucket path. |
Full Refresh - Append Sync | ❌ | |
Incremental - Append | ❌ | |
Incremental - Deduped History | ❌ | |
Namespaces | ❌ |
Supported Streams
This source provides a single stream per file with a dynamic schema. The current supported type file: .csv and .json More formats (e.g. Apache Avro) will be supported in the future.