SFTP

sftp inbound lists and reads files from a remote SFTP server.

Structure

{
  "type": "sftp",
  "tag": "sftp-in",
  "host": "example.com",
  "port": 22,
  "user": "backup",
  "password": "",
  "private_key": "",
  "private_key_passphrase": "",
  "path": "/data"
}

Fields

host

Required

The SFTP server hostname or IP address.

port

The SFTP server port.

22 is used by default.

user

Required

The username for authentication.

password

Password for authentication.

Password authentication is not used if empty.

private_key

Path to the private key for authentication.

Key-based authentication is not used if empty.

private_key_passphrase

Passphrase for the private key.

path

Required

The remote path to backup.