Skip to main content
POST
Create SFTP connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Maximum string length: 160
host
string
required
Maximum string length: 255
username
string
required
Maximum string length: 255
password
string<password>
required
write-only
Maximum string length: 255
used_for
enum<string>
required

Determines which remote path fields are required and stored.

Available options:
import,
export,
both
port
integer | null
default:22
Required range: 1 <= x <= 65535
import_filepath
string | null

Required when used_for is import or both.

Maximum string length: 255
export_filepath
string | null

Required when used_for is export or both.

Maximum string length: 255

Response

SFTP connection created.

message
string
required
Example:

"SFTP connected."

data
object
required
Last modified on July 20, 2026