sftp

6 configuration options · available in Rust, Python, Node.js, Java

Quick start
use opendal::Operator;

let op = Operator::via_iter("sftp", [
])?;

All configuration options (copy & trim)

Full reference
use opendal::Operator;

let op = Operator::via_iter("sftp", [
    // endpoint of this backend
    // ("endpoint".to_string(), "...".to_string()),

    // root of this backend
    // ("root".to_string(), "...".to_string()),

    // user of this backend
    // ("user".to_string(), "...".to_string()),

    // key of this backend
    // ("key".to_string(), "...".to_string()),

    // known_hosts_strategy of this backend
    // ("known_hosts_strategy".to_string(), "...".to_string()),

])?;

Every option is passed as a string key; OpenDAL parses it into the right type. Some services may require building the binding with the matching services-* feature enabled.

Configuration reference

General6

Key	Type	Required	Description
`endpoint`	string	no	endpoint of this backend
`root`	string	no	root of this backend
`user`	string	no	user of this backend
`key`	string	no	key of this backend
`known_hosts_strategy`	string	no	known_hosts_strategy of this backend
`enable_copy`deprecated	bool	no	Deprecated: SFTP copy capability is enabled by default. Deprecated since 0.57.0: SFTP copy capability is enabled by default and this option is no longer needed.