SFTP

SFTP file transfer — upload, download, list, and manage files on remote servers via SSH File Transfer Protocol.

Overview

Property	Value
Type	custom
Authentication	basic
Category	Generic

Configuration

Field	Type	Required	Description
host	string	Yes	SFTP server hostname
port	number	No	Port (default: 22)
username	string	Yes	SSH username
password	string	No	SSH password (if not using key auth)
private_key	string	No	PEM-encoded SSH private key
passphrase	string	No	Passphrase for the private key
base_path	string	No	Base directory path (default: /)

Available actions

Upload File

Upload a file to a remote SFTP server.

Endpoint	POST /upload
Method	POST

Download File

Download a file from a remote SFTP server.

Endpoint	GET /download/{remotePath}
Method	GET

List Directory

List files and subdirectories in a remote SFTP directory.

Endpoint	GET /ls/{remotePath}
Method	GET

Delete File

Delete a file from a remote SFTP server.

Endpoint	DELETE /file/{remotePath}
Method	DELETE

Create Directory

Create a directory on the remote SFTP server. Creates parent directories if needed.

Endpoint	POST /mkdir
Method	POST

Example flow

flows/generate-report-and-upload-sftp.yaml

flow: generate-report-and-upload-sftp
version: 1
description: Generate a CSV report, upload to partner SFTP server, and send confirmation email

source:
  connector: internal-api
  trigger: schedule
  cron: "0 6 * * 1"

steps:
  - name: fetch-weekly-data
    target: postgresql-prod
    action: query
    mapping:
      table: order_summaries
      where:
        created_at: ">= now() - interval '7 days'"
    store_as: report_data

  - name: upload-to-partner
    target: sftp-partner
    action: upload-file
    mapping:
      remotePath: /incoming/reports/weekly-{{ now | date("YYYY-MM-DD") }}.csv
      content: report_data | to_csv
      overwrite: true
    store_as: upload_result

  - name: send-confirmation
    target: sendgrid-prod
    action: send-email
    mapping:
      to: partner-ops@example.com
      subject: "Weekly report uploaded"
      body: "Report uploaded to /incoming/reports/weekly-{{ now | date('YYYY-MM-DD') }}.csv ({{ report_data | length }} rows)"

on_error:
  retry: 3x exponential(30s)
  then: dead-letter