Introduction
This guide explains how to install and authenticate the SFTP Private Key Connector for use in Cyclr.
SFTP Private Key Connector enables secure file transfer over SFTP (SSH File Transfer Protocol) using a private key for authentication, instead of a username and password. It is designed for environments where enhanced security policies require key-based access, such as enterprise systems, managed hosting, or government and healthcare infrastructure.
SFTP provides encrypted communication by default, protecting both credentials and file data during transfer.
Setup
The SFTP Private Key Connector allows you or your customer to connect Cyclr to an SFTP server using SSH key-based authentication.
SFTP Private Key Connector Installation
When installing an SFTP Private Key Connector, the following values are used:
| Property | Description |
|---|---|
| Host URI | The SFTP server address (e.g. sftp://example.com). |
| Port | The port number for SFTP |
| Username | The username associated with the private key, e.g.: sftp_user. |
| Private Key | Paste or upload the SSH private key for authentication. The PKCS #1 RSA private key that the SFTP server knows as an authorized_key for the username provided. Example: -----BEGIN RSA PRIVATE KEY----- |
| Passphrase (optional) | The passphrase used to unlock the private key, if required. |
| Server Time Zone | The time zone of the SFTP server, in TZ database format (e.g. Europe/London). If not set correctly the List Updated Files method will not function as expected. |
Additional Information
Supported Protocols
This Connector supports SFTP only. Unlike the FTP Connector, it does not connect via plain FTP or FTPS.
SFTP Private Key uses SSH (Secure Shell) for encryption, ensuring all communication, including authentication and file transfer, is fully secured.
Defining File Structures
When retrieving delimited (CSV) or XML files, the file structure must be defined before mapping data into other applications.
- Open the Connector’s settings page.
- Copy the Delimited Text Files or XML Files method category.
- Rename the new category (e.g. Customer CSV Files).
- Select Generate Fields and provide a representative file sample (e.g. header and one row of CSV data).
- Cyclr will automatically create matching fields, making them available for mapping in downstream steps.
This allows you to handle multiple file formats or structures from a single SFTP source.
IP Allowlist
If the SFTP server is not publicly accessible, ensure you allow Cyclr to connect to it by creating exceptions in firewalls, etc. as necessary.
See Cyclr IP Allowlist.