> For the complete documentation index, see [llms.txt](https://docs.verygoodsecurity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verygoodsecurity.com/vault/batch-file-transmission/sftp-proxy.md).

# SFTP Proxy

> Please note, to access the SFTP Proxy feature - contact us at <support@vgs.io>

SFTP stands for Secure Shell (SSH) File Transfer Protocol, a network protocol used for secure transfer of data over the internet.

The protocol supports the full security and authentication functionality of SSH, and is widely used to exchange data between business partners. SFTP servers are often used to reconcile payment transactions and such documents often contain highly sensitive data.. Documents are pre-processed by VGS during SFTP GET and SFTP PUT operations. By configuring filtering rules in the VGS Dashboard, customers can filter sensitive data within documents sent via SFTP.

![sftp-proxy](/files/yxYPmbKVeqH8FF0Djwa3)

## Configuring SFTP Proxy

Check [SFTP routes](/vault/batch-file-transmission/sftp-proxy/sftp.md) article with step-by-step guide for configuring SFTP flow.

Use SFTP [Access Logs](/vault/http-proxy/access-logger.md) to test and debug the integration.

### Key Management

When configuring key-based authentication on the VGS Dashboard, please note that we support both **RSA** and **OpenSSH** key formats. The supported key algorithms are: **RSA** and **Ed25519**.

### Integration Examples

**Scenario 1**

With an SFTP GET, a CSV document is pre-processed in transit by VGS. All the fields with sensitive data are replaced with cells with aliased data. This data is then stored with VGS for later use. A typical use case is reconciliation of payment transactions.

**Scenario 2**

With an SFTP PUT, a CSV document is pre-processed in transit by VGS. A reverse replacement occurs as the file is passed to the payment processor, thus completing the transaction.

The typical upstream backend is an SFTP server of a Payment Processor / Bank.


---

# 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.verygoodsecurity.com/vault/batch-file-transmission/sftp-proxy.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.
