Skip to main content
Skip table of contents

Sftp File Store



Description

An SFTP server to manage files

Type

sftp

Category

File



Configuration

Name

Description

Type

Mandatory

Comment

HostName

Host address of the SFTP 

string

TRUE


Port

Port of the SFTP server

int

FALSE

Default: 22

Username

The user used to connect to the SFTP 

string

TRUE


Password

In case of authentication using Username / Password: The password to use to log into the SFTP.

string

TRUE FOR PASSWORD AUTH

KeyPath

In case of authentication using Keypair: Path of the private key used to connect to the SFTP server

string

TRUE FOR KEY AUTH

Both usual Linux key formats (RSA & OpenSSH) are supported.

KeyPassword

In case of authentication using Keypair: Password used to read the private key

string

TRUE FOR KEY AUTH


BasePath

The base directory on the SFTP server

string

TRUE



Using key auth

CODE
{
    "Name": "sftp-server",
    "Type": "sftp",
    "HealthCheck": true,
    "Config": {
        "HostName": "sftp.dfakto.com",
		"Port": 23,
	 	"Username": "username",
	 	"KeyPath": "./key.pem",
		"KeyPassword": "password",
		"BasePath": "/"
    }
}

Using Password auth

CODE
{
    "Name": "sftp-server",
    "Type": "sftp",
    "HealthCheck": true,
    "Config": {
        "HostName": "sftp.dfakto.com",
		"Port": 23,
	 	"Username": "username",
	 	"Password": "Pa$$w0rd",
		"BasePath": "/"
    }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.