SFTP

Transfer files between local and remote servers via SFTP.

DAG-Level Configuration

ssh:
  user: deploy
  host: server.example.com
  key: ~/.ssh/deploy_key

steps:
  - name: upload-config
    type: sftp
    config:
      direction: upload
      source: /local/config.yaml
      destination: /remote/config.yaml

  - name: download-logs
    type: sftp
    config:
      direction: download
      source: /var/log/app.log
      destination: /local/app.log

Step-Level Configuration

steps:
  - name: upload-file
    type: sftp
    config:
      user: deploy
      host: server.example.com
      key: ~/.ssh/deploy_key
      direction: upload
      source: /local/file.txt
      destination: /remote/file.txt

Configuration

Field	Required	Default	Description
user	Yes	-	SSH username
host	Yes	-	SSH hostname
port	No	22	SSH port
key	No	Auto-detect	Private key path
password	No	-	SSH password
strict_host_key	No	true	Enable host key verification
known_host_file	No	~/.ssh/known_hosts	Known hosts file path
timeout	No	30s	Connection timeout
direction	No	upload	upload or download
source	Yes	-	Source path (local for upload, remote for download)
destination	Yes	-	Destination path (remote for upload, local for download)
bastion	No	-	Bastion host configuration (same as SSH)

Directory Transfer

Directories are transferred recursively:

steps:
  - name: upload-dir
    type: sftp
    config:
      direction: upload
      source: /local/project/
      destination: /remote/project/

  - name: download-dir
    type: sftp
    config:
      direction: download
      source: /remote/backup/
      destination: /local/backup/

Atomic Uploads

Uploads write to a temporary file (.boltbase-tmp-{random}) then rename to the final destination. This prevents partial files on failure.

See Also

• SSH - Remote command execution
• S3 - S3 file operations