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


KeyPath

Path of the key used to connect to the SFTP server

string

TRUE

RSA keys must be in “old” format. Or you may have the error “(openssh key type: ssh-rsa is not supported)”

To create the rsa key (old format) :

CODE
ssh-keygen -m PEM -t rsa -b 4096

if the key is more recent, you can convert it with this command

CODE
ssh-keygen -p -f id_rsa -m pem

KeyPassword

Password used to read the key

string

TRUE


BasePath

The base directory on the SFTP server

string

TRUE



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


JavaScript errors detected

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

If this problem persists, please contact our support.