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

# SFTP

> Provides filesystem access through the Secure File Transfer Protocol (SFTP).

Connect Alumio to an SFTP server and use it like a filesystem: read files from it and write files to it. SFTP transfers files over an encrypted SSH connection, so use this whenever you need to exchange files securely with a system that offers an SFTP server. You can sign in with either a password or a private key.

This documentation describes: [Schema](/schemas/filesystem/sftp)

## Fields

### General

**Hostname**

Required

The address of the SFTP server, for example `sftp.example.com`.

**Port**

Optional

The port the SFTP server listens on. Defaults to `22`, the standard SFTP port. Only change this if your server uses a different port.

**Username**

Required

The username of the SFTP account Alumio signs in with.

**Login method**

Optional

How Alumio signs in. Choose **Login with password** to use a password, or **Login with private key** to use an SSH key. Your choice decides which of the fields below you fill in. Defaults to **Login with password**.

**Password**

Optional

The password that goes with the username. Shown when the login method is **Login with password**. Keep this confidential.

**Private key**

Optional

The SSH private key Alumio signs in with. Shown when the login method is **Login with private key**. It is a multi-line block that starts with `-----BEGIN RSA PRIVATE KEY-----` and ends with `-----END RSA PRIVATE KEY-----`. Keep this confidential.

**Passphrase for private key**

Optional

The passphrase that unlocks the private key, if it has one. Shown when the login method is **Login with private key**. Passphrases are currently only supported for keys created with `ssh-keygen -m pem -t rsa`.

### Advanced

**Remote root directory**

Optional

The folder on the server that all reads and writes are relative to, so you do not have to repeat it in each path. Leave empty to use the server's default starting directory.

**Connection timeout**

Optional

How long, in seconds, Alumio waits for the server to respond before giving up. Can range from 0 to 600.

**Directory permissions**

Optional

The permissions Alumio sets on any folders it creates on the server, written as a three-digit octal value such as `0744`. Defaults to `0744`. Leave it alone unless your server requires specific permissions.

**SSH fingerprint**

Optional

The server's SSH fingerprint, used to confirm Alumio is talking to the right server and not an impostor. For example `88:76:75:96:c1:26:7c:dd:9f:87:50:db:ac:c4:a8:7c`. Leave empty to skip this check.

**Logger**

Optional

Selects how file activity on this connection is recorded, so you can trace which files were read or written.

See the [filesystem-logger](/references/filesystem-logger) reference.

## Sample data

A connection to an SFTP server using password sign-in, reading and writing within the `inbound` folder.

| Field | Value |
| - | - |
| Hostname | `sftp.example.com` |
| Username | `your-username` |
| Login method | Login with password |
| Password | `your-password` |
| Remote root directory | `inbound` |

```json Configuration theme={null}
{
  "prototype": "sftp",
  "parameters": {
    "config": {
      "host": "sftp.example.com",
      "username": "your-username",
      "loginMethod": "password",
      "password": "your-password",
      "root": "inbound"
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.