> For the complete documentation index, see [llms.txt](https://docs.bdb.ai/data-pipeline-2/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bdb.ai/data-pipeline-2/components/readers/sftp-reader.md).

# SFTP Reader

SFTP Reader is designed to read and access files stored on an SFTP server. SFTP readers typically authenticate with the SFTP server using a username and password or SSH key pair, which grants access to the files stored on the server

All component configurations are classified broadly into the following sections:

* [​Basic Information​](/data-pipeline-2/components/component-base-configuration.md)​
* Meta Information
* [Resource Configuration​](/data-pipeline-2/components/resource-configuration.md)​
* ​[Connection Validation](https://docs.bdb.ai/7.6/data-pipeline/components/connection-validation)

{% hint style="info" %}
Please follow the demonstration to configure the SFTP Reader and its meta information.
{% endhint %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2FKDnuVkODcyqcTIc4YVeo%2Fsftp%20reader%20(online-video-cutter.com).mp4?alt=media&token=830d1c85-dc31-4cf8-b6a9-3202a92e5ebd>" %}

**Please go through the below given steps to configure SFTP Reader component:**

<figure><img src="/files/QmOrgIBxFoU8oQ64bquX" alt=""><figcaption><p>Meta Information tab</p></figcaption></figure>

* **Host**: Enter the host.&#x20;
* **Username**: Enter username for SFTP reader.&#x20;
* **Port**: Provide the Port number.&#x20;
* **Dynamic Header:** It can automatically detect the header row in a file and adjust the column names and number of columns as necessary.
* **Authentication**: Select an authentication option using the drop-down list.
  * **Password**: Provide a password to authenticate the SFTP component
  * **PEM/PPK File:** Choose a file to authenticate the SFTP component. The user needs to upload a file if this authentication option has been selected.&#x20;
* **Reader Path**: Enter the path from where the file has to be read.&#x20;
* **Channel**: Select a channel option from the drop-down menu (the supported channel is SFTP).&#x20;
* **Column filter:** Select the columns which you want to read and if you want to change the name of the column, then put that name in the alias name section otherwise keep the alias name the same as of column name and then select a Column Type from the drop-down menu. &#x20;
* Use ***Download Data*** and ***Upload File*** options to select the desired columns.
  * **Upload File:** The user can upload the existing system files (CSV, JSON) using the Upload File icon.&#x20;
  * **Download Data (Schema):** Users can download the schema structure in JSON format by using the Download Data icon.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bdb.ai/data-pipeline-2/components/readers/sftp-reader.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.