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

# SFTP Connector

<Badge icon="arrow-left" color="gray">[Back to the list of Connectors](/agent-platform/knowledge#connectors)</Badge>

The SFTP connector enables Artemis to index content from an SFTP server into a knowledge base. During setup, you authenticate using an SFTP authentication profile, configure the server connection, specify the folders to synchronize, apply file filters, and validate the configuration before starting synchronization.

The connector supports **Basic** and **SSH Key** authentication, configurable folder scope, file filtering, and scheduled synchronization.

## Specifications

| Specification           | Description                               |
| ----------------------- | ----------------------------------------- |
| Supported content       | PDF, DOCX, TXT, CSV, MD, XLSX, JSON, HTML |
| Authentication          | Basic, SSH Key                            |
| Permission-aware search | No                                        |
| Real-time sync          | No                                        |
| Delta sync              | Yes                                       |

## Prerequisites

Make sure that,

* You have access to the SFTP server you want to index.

* You've created a SFTP authentication profile (from **Settings > Auth Profiles**).

* You've configured the authentication profile with one of the following:

  * Username and password for **Basic** authentication.
  * Username, SSH private key, and optional passphrase for **SSH Key** authentication.

* You have read access to the folders you want to synchronize.

* You know the SFTP host, port, and, if required, the server host key fingerprint.

## Configure an SFTP Connector

1. Navigate to **Knowledge Base** > **Sources**.
2. Click **Add Source**.
3. Select **SFTP**.
4. Enter the following details.

### Connection

| Field                        | Description                                                                                                                                           |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| SFTP Auth Profile            | Authentication profile used to connect to the SFTP server. You can use **Basic** or **SSH Key** authentication for the connection.                    |
| Auth Type                    | Authentication method. Supported values are **Basic** and **SSH Key**. Select the same authentication method configured in the selected Auth Profile. |
| SFTP Host                    | Hostname or IP address of the SFTP server.                                                                                                            |
| Port                         | SFTP server port. The default port is **22**.                                                                                                         |
| SHA-256 Host Key Fingerprint | Server's SHA-256 host key fingerprint for host identity verification.                                                                                 |
| Username                     | Username used to authenticate with the SFTP server.                                                                                                   |

### Folder Scope

| Field                | Description                                                                                                |
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
| Full Sync Root       | Root directory to scan during a full synchronization.                                                      |
| Delta Sync Root      | Root directory used during delta synchronization. Leave blank to use the Full Sync Root.                   |
| Recursive Listing    | Determines whether nested folders under the configured root are included during synchronization.           |
| Include Hidden Files | Determines whether hidden files are included during synchronization. Hidden files are excluded by default. |

### Filters and Schedule

| Field                   | Description                                                                                                          |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
| Include Globs           | Glob patterns that identify files to include during synchronization.                                                 |
| Exclude Globs           | Glob patterns that identify files to exclude during synchronization.                                                 |
| Allowed Extensions      | File extensions that are eligible for synchronization.                                                               |
| Modified After          | Restricts synchronization to files modified after the specified date. Leave blank to synchronize all eligible files. |
| Max File Size (MB)      | Maximum file size that can be synchronized. Files exceeding this size are skipped.                                   |
| Max Files Per Run       | Maximum number of files processed during a synchronization run.                                                      |
| Concurrent Downloads    | Maximum number of files downloaded simultaneously during synchronization.                                            |
| Delta Cadence (Minutes) | Frequency of delta synchronization runs.                                                                             |

## Actions

* Click **Generate Proposal Preview** to validate the connector configuration, selected folder scope, filters, and estimated synchronization workload before approval.
* Click **Run Dry Run** to validate the connector configuration without initiating synchronization.
* Click **Approve & Start** to initiate synchronization with the configured SFTP server.