SFTP (password-based auth)

Interact with an SFTP (SSH File Transfer Protocol) Server using a username and password for auth

Go to site
Explore
/
Apps
/
SFTP (password-based auth)

SFTP (password-based auth) API Integrations

Build and run workflows using the SFTP (password-based auth) API. Use 1000s of open source triggers and actions across 800+ apps. Or write custom code to integrate any app or API in seconds.

module.exports = defineComponent({
  props: {
    sftp_password_based_auth: {
      type: "app",
      app: "sftp_password_based_auth",
    }
  },
  async run({steps, $}) {
    const Client = require('ssh2-sftp-client');
    
    const { 
      host,
      username,
      password,
    } = this.sftp_password_based_auth.$auth
    
    const config = {
      host,
      username,
      password,
    }
    
    const sftp = new Client()
    
    await sftp.connect(config)
    this.cwd = await sftp.cwd();
    return await sftp.end();
  },
})

Authentication

SFTP (password-based auth) uses API keys for authentication. When you connect your SFTP (password-based auth) account, Pipedream securely stores the keys so you can easily authenticate to SFTP (password-based auth) APIs in both code and no-code steps.

Below, enter the hostname of the SFTP server you'd like to connect to, your username, and the password you'd like to use to connect.

This app only supports password-based authentication, not authentication via private key. If you need to use a private key to connect to a host, please use the SFTP (key-based auth) app, instead.