File transfer connections (SSH / SFTP / FTP)

Three closely-related connectors for moving files and running remote commands, all the same host:port + login/password shape:

Declare the provider

# leoflow.yaml
dag_id: file_pull
connectors:
  - sftp        # or ssh / ftp

Fields the UI asks for

The host:port + login/password round-trip (reserved characters) is covered by TestFileTransferConnectionURIShapeIntegration across all three.

Example DAG (copy-paste) — SFTP

Docs-only recipe (needs a reachable SFTP server). Hook imported inside the task.

# dag.py
from __future__ import annotations

from airflow.sdk import DAG, task


@task
def pull() -> None:
    from airflow.providers.sftp.hooks.sftp import SFTPHook

    hook = SFTPHook(ssh_conn_id="sftp_default")
    print("pull: listing /incoming via SFTPHook(sftp_default)")
    for name in hook.list_directory("/incoming"):
        print("  ", name)
    hook.retrieve_file("/incoming/data.csv", "/tmp/data.csv")
    print("pull: downloaded data.csv")


with DAG("file_pull", schedule=None, catchup=False, tags=["example"]):
    pull()

# leoflow.yaml
schema_version: "1.0"
dag_id: file_pull
description: Download a file over SFTP via SFTPHook.
owner: examples
tags: [example]
python_version: "3.11"
connectors:
  - sftp

ssh and ftp follow the same shape — swap the hook (SSHHook/FTPHook) and the connectors: entry.

Security notes

• Prefer key auth (key_file / private_key in Extra) over passwords for ssh/sftp; the key is encrypted at rest.
• Host-key checking: leave it on in production; no_host_key_check is for throwaway/dev only.
• FTP is plaintext unless you use FTPS — avoid it for credentials over untrusted networks.

Related

• docs/connections/index.md — Installing a connector’s provider.
• ADR 0019 / 0021 — secret encryption + agent delivery.