---
title: "SFTP Connector | Lansweeper Platform"
slug: "sftp-connector"
description: "Learn to read, write, move, and delete files on an SFTP server using username/password or private key connections for secure file management."
status: "update"
updated: 2026-07-17T16:10:41Z
published: 2026-07-17T16:10:41Z
canonical: "docs.lansweeper.com/sftp-connector"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lansweeper.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SFTP Connector

Note on third‑party tools

              

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

[SFTP (SSH File Transfer Protocol)](https://www.ssh.com/academy/ssh/sftp-ssh-file-transfer-protocol) is a secure file transfer protocol that operates over SSH. The SFTP component allows uploading, downloading, moving, and deleting files on an SFTP server.

## Connections

### Basic Authentication

Authenticate using username and password

The **Basic Authentication** connection is used to connect to SFTP servers that support username / password login.

#### Prerequisites

- An SFTP server with username/password authentication enabled
- Valid credentials (username and password)

#### Configure the Connection

- **Username**: Enter the SFTP account username
- **Password**: Enter the SFTP account password
- **Host**: Enter the SFTP server hostname or IP address
- **Port**: Enter the SFTP server port (default: 22)

#### Advanced Settings (Optional)

- **Timeout**: Connection timeout in milliseconds (default: 3000)
- **Enable Unsecure Server Host Key Algorithms**: Enable deprecated host key algorithms for legacy servers
- **Enable Unsecure Ciphers**: Enable CBC ciphers for legacy servers
- **Custom Server Host Key Algorithms**: Comma-separated list of custom host key algorithms (overrides defaults)
- **Custom Ciphers**: Comma-separated list of custom ciphers (overrides defaults)

Consult the SFTP server administrator to determine which login method the server supports.

| Input | Comments | Default |
| --- | --- | --- |
| Password | The password for SFTP authentication. |  |
| Username | The username for SFTP authentication. |  |
| Host | The address of the SFTP server. This should be either an IP address or hostname. |  |
| Port | The port of the SFTP server. | 22 |
| Timeout | How long the client will await a request. | 3000 |
| Enable Unsecure Server Host Key Algorithms | When true, unsecure server host key algorithms will be added to the connection. | false |
| Enable Unsecure Ciphers | When true, CBC ciphers will be added to the connection. | false |
| Custom Server Host Key Algorithms | A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting. |  |
| Custom Ciphers | A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting. |  |

### Private Key

Authenticate using SSH private key

The **Private Key** connection allows access to an SFTP server via SSH [public/private key authentication](https://www.ssh.com/academy/ssh/public-key-authentication).

#### Prerequisites

- An SFTP server with public key authentication enabled
- A generated public/private SSH key pair
- The public key must be stored on the SFTP server

#### Setup Steps

1. Generate a public/private SSH key pair if not already available
2. Copy the public key to the SFTP server (usually to `~/.ssh/authorized_keys`)
3. Verify the key is properly configured with the SFTP server administrator

#### Configure the Connection

- **Username**: Enter the SFTP account username
- **Private Key**: Enter the complete private key (including headers and footers)
- **Key Passphrase**: Enter the passphrase for the private key (if applicable)
- **Password**: Enter the password if the server requires both private key and password authentication (uncommon)
- **Host**: Enter the SFTP server hostname or IP address
- **Port**: Enter the SFTP server port (default: 22)

#### Advanced Settings (Optional)

- **Timeout**: Connection timeout in milliseconds (default: 3000)
- **Enable Unsecure Server Host Key Algorithms**: Enable deprecated host key algorithms for legacy servers
- **Enable Unsecure Ciphers**: Enable CBC ciphers for legacy servers
- **Custom Server Host Key Algorithms**: Comma-separated list of custom host key algorithms (overrides defaults)
- **Custom Ciphers**: Comma-separated list of custom ciphers (overrides defaults)

Authentication is performed using the username and corresponding private key.

| Input | Comments | Default |
| --- | --- | --- |
| Private Key | The SSH private key for authentication. |  |
| Key Passphrase | The passphrase for the private key. Leave blank if none. |  |
| Password | Though uncommon, some SFTP servers that use private keys may also require a password. Leave blank if none. |  |
| Username | The username for SFTP authentication. |  |
| Host | The address of the SFTP server. This should be either an IP address or hostname. |  |
| Port | The port of the SFTP server. | 22 |
| Timeout | How long the client will await a request. | 3000 |
| Enable Unsecure Server Host Key Algorithms | When true, unsecure server host key algorithms will be added to the connection. | false |
| Enable Unsecure Ciphers | When true, CBC ciphers will be added to the connection. | false |
| Custom Server Host Key Algorithms | A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting. |  |
| Custom Ciphers | A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting. |  |

## Triggers

### New or Modified Files

Checks for new and modified files in a directory on an SFTP server on a configured schedule.

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | The path of the directory on the SFTP server to list files from. |  |
| Pattern | The glob-style pattern for filtering files (e.g., *.txt). | * |
| Include Subdirectories | When true, recursively monitors files in all subdirectories. When false, only monitors files in the specified directory. | false |

## Actions

### Append File

Append data to an existing file on a SFTP server.

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | The path on the SFTP server where data will be appended. |  |
| Data | The text or data to append to the file. |  |

### Create Directory

Create a new directory. When Include Subfolders is enabled, recursively creates any missing directories in the path.

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | The path of the directory on the SFTP server to list files from. |  |
| Include Subfolders | When true, recursively creates any missing directories in the path. | true |

### Delete File

Delete a file from a SFTP server

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | Path of file to delete |  |

### Fast Get

Read a file from SFTP

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | Path of file on SFTP server to read data from |  |
| Return Buffer | When true, treats the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8. | false |

### List Directory

List files and directories in a directory on an SFTP server. Optionally list files in subdirectories.

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | The path of the directory on the SFTP server to list files from. |  |
| Pattern | The glob-style pattern for filtering files (e.g., *.txt). | * |
| Include Subdirectories | When true, recursively monitors files in all subdirectories. When false, only monitors files in the specified directory. | false |
| Include Directories | When true, lists directories in addition to files. When false, only lists files. | false |

### Move File

Move a file on an SFTP server

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Source Path | Path of file to move |  |
| Destination Path | Path of file to move |  |

### Read File

Read a file from SFTP

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | Path of file on SFTP server to read data from |  |
| Return Buffer | When true, treats the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8. | false |

### Stat File

Pull statistics about a file

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | Path of file on SFTP server to read data from |  |

### Write File

Write a file to SFTP

| Input | Comments | Default |
| --- | --- | --- |
| Connection | The SFTP connection to use. |  |
| Path | The path to the file on the SFTP server. |  |
| Data | The text or data to write into the file. |  |