Connect to an SFTP site.

This provider requires a format so that files are properly processed.

SFTPReader Properties

  • password (Env First): The SFTP password.
  • path (Inline Only): The SFTP directory path.
  • host (Env First): The SFTP host.
  • user (Env First): The SFTP username (for both password and SSH authentication).
  • credentialType (Env First): The type of credential password or ssh-key (default: password)
  • privateKey (Env First): The private key associated with SSH authentication.
  • port (Inline Only): The port of the SFTP host (default: 22)
  • passphrase (Inline Only): The passphrase of the private key
Example with Environment Credentials
-
    name: myConnectorName
    type: SFTPReader
    format: myDataFormatter
    properties:
      path:  / 
      port:  22  # optional 
    #schemaRef: schemaName # optional from "schemas:"
Example with Inline Credentials
-
    name: myConnectorName
    type: SFTPReader
    format: myDataFormatter
    properties:
      password: xxxx  # optional 
      path: / 
      host: sftp.mydomain.com 
      user: xxxx 
      credentialType: password  # optional 
      privateKey: |
        -----BEGIN RSA PRIVATE KEY-----  # optional 
      port: 22  # optional 
      passphrase: xxxx  # optional 
    #schemaRef: schemaName # optional from "schemas:"

SFTPWriter Properties

  • password (Env First): The SFTP password.
  • path (Inline Only): The SFTP directory path.
  • host (Env First): The SFTP host.
  • user (Env First): The SFTP username (for both password and SSH authentication).
  • credentialType (Env First): The type of credential password or ssh-key (default: password)
  • privateKey (Env First): The private key associated with SSH authentication.
  • port (Inline Only): The port of the SFTP host (default: 22)
Example with Environment Credentials
-
    name: myConnectorName
    type: SFTPWriter
    format: myDataFormatter
    properties:
      path:  / 
      port:  22  # optional 

Example with Inline Credentials
-
    name: myConnectorName
    type: SFTPWriter
    format: myDataFormatter
    properties:
      password:  xxxx  # optional 
      path:  / 
      host:  sftp.mydomain.com 
      user:  xxxx 
      credentialType:  password  # optional 
      privateKey:  |
        -----BEGIN RSA PRIVATE KEY-----  # optional 
      port:  22  # optional