Skip to content

Storage: SFTP

Field Type JSON key Description
Host string host SFTP server hostname or IP address.
Port int port SFTP server port (default 22).
User string user Username for SFTP authentication.
Password string password Password for SFTP authentication. Leave empty when using a key file.
KeyFile string key_file Path to the private key file for key-based authentication.
BasePath string base_path Base directory on the server under which backups are stored.
Path string path Deprecated alias for BasePath, kept for backward compatibility.
HostKey string host_key SHA-256 fingerprint of the server's host public key for verification.
KnownHostsFile string known_hosts_file Path to an OpenSSH known_hosts file used to verify the host key.