SFTP (password-based auth)

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

Integrate the SFTP (password-based auth) API with the Node API

Setup the SFTP (password-based auth) API trigger to run a workflow which integrates with the Node API. Pipedream's integration platform allows you to integrate SFTP (password-based auth) and Node remarkably fast. Free for developers.

Run Node Code with Node API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Node
 
Try it
New Remote Directory Watcher from the SFTP (password-based auth) API

Emit new events when files get created, changed or deleted from a remote directory. See the docs

 
Try it
Run Node Code with the Node API

Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the Pipedream Node docs to learn more.

 
Try it
Upload String as File with the SFTP (password-based auth) API

Uploads a UTF-8 string as a file on an SFTP server

 
Try it

Overview of SFTP (password-based auth)

SFTP (Secure File Transfer Protocol) is a network protocol that provides secure
file transfers over secure shell (SSH) connections. It is an extension of the
Secure Shell protocol, designed for secure file exchange between hosts. A user
can securely transfer files between systems without having to worry about
external threats, as the protocol is encrypted and authenticated.

With the SFTP API, you can build applications that securely transfer data, such
as files and documents, between two different systems. Some example
applications include:

  • Secure document sharing between two systems
  • Secure file synchronization between two systems
  • Secure backups of data over the network
  • Secure transfers of large files
  • Secure uploads and downloads of data
  • Media streaming between two systems

Connect SFTP (password-based auth)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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();
  },
})

Connect Node

1
2
3
4
5
6
7
// To use previous step data, pass the `steps` object to the run() function
export default defineComponent({
  async run({ steps, $ }) {
    // Return data to use it in future steps
    return steps.trigger.event
  },
})

Community Posts

Automate checking a ticket system's availability with Node.js and Pipedream
Automate checking a ticket system's availability with Node.js and Pipedream
How I used Node.js and Pipedream to automatically scrape a ticket booking site and notify me if availability had changed.