SFTP (key-based auth)

Interact with an SFTP (SSH File Transfer Protocol) Server using a private key for auth

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

SFTP (key-based auth) API Integrations

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

Overview

SFTP (SSH File Transfer Protocol) is a secure file transfer protocol for exchanging files between computers over a secure connection. The protocol utilizes public-key cryptography to provide authentication and encryption of the data being transferred. SFTP is widely used in enterprise environments for securely transferring data between locations and users, as well as for managing remote computer systems (for example, for monitoring and software/security updates).

Here are some examples of what you can build using the SFTP (key-based auth) API:

  • Secure file backup and restore solutions.
  • Text editors that can securely open, modify and save remote files.
  • Manage remote uploads, downloads, editing, navigation, etc.
  • Automate remote system management tasks (e.g., installation of applications, software/security updates).
  • Share and sync files between multiple systems.
  • Remote user authentication.
  • Custom solutions tailored to specific needs.
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: {
      type: "app",
      app: "sftp",
    }
  },
  async run({steps, $}) {
    const Client = require('ssh2-sftp-client');
    
    const { 
      host,
      username,
      privateKey,
    } = this.sftp.$auth
    
    const config = {
      host,
      username,
      privateKey,
    }
    
    const sftp = new Client()
    
    await sftp.connect(config)
    this.cwd = await sftp.cwd();
    return await sftp.end();
  },
})

Choose an API to Connect with SFTP (key-based auth) API

1
-
24
of
1,700+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Filter
Filter
Specify a condition that your workflow must meet and whether you'd like to proceed or end workflow execution.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Airtable (OAuth)
Airtable (OAuth)
Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.
Zoom
Zoom
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Gmail
Gmail
Gmail offers private and secure email by Google at no cost, for business and consumer accounts.
Gmail (Developer App)
Gmail (Developer App)
Private and secure email by Google at no cost, for business and consumer accounts. Use this app to connect your own developer account credentials.
Email
Email
Trigger workflows on new emails, and send emails to yourself as part of a Pipedream workflow.
Delay
Delay
Delay, pause, suspend, or have the execution of your workflow wait for as little as one millisecond, or as long as one year.
Go
Go
Anything you can do in Go, you can do in a Pipedream Workflow. You can use any of Go packages available with a simple import.
Premium
Zoom Admin
Zoom Admin
Video conferencing (includes account-level scopes) for Zoom Admins.
Twilio
Twilio
Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.
Bash
Bash
Run any Bash in a Pipedream step within your workflow, including making curl requests.
Upload String as File with SFTP (key-based auth) API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + SFTP (key-based auth)
 
Try it
Send Message (Advanced) with Discord Webhook API on New Remote Directory Watcher from SFTP (key-based auth) API
SFTP (key-based auth) + Discord Webhook
 
Try it
Add Multiple Rows with Google Sheets API on New Remote Directory Watcher from SFTP (key-based auth) API
SFTP (key-based auth) + Google Sheets
 
Try it
Upload String as File with SFTP (key-based auth) API on New Item in Feed from RSS API
RSS + SFTP (key-based auth)
 
Try it
Upload String as File with SFTP (key-based auth) API on New Message from Discord API
Discord + SFTP (key-based auth)
 
Try it
New Remote Directory Watcher from the SFTP (key-based auth) API

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

 
Try it
Upload File with the SFTP (key-based auth) API

Uploads a file or string in UTF-8 format to the SFTP server. See the documentation

 
Try it

Authentication

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

This app holds details for an SFTP server you want to interact with in Pipedream.

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

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