Upload File with SFTP (key-based auth) API

Pipedream makes it easy to connect APIs for SFTP (key-based auth) and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Upload File with the SFTP (key-based auth) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Upload File action
1. Connect your SFTP (key-based auth) account
2. Optional- Configure File Path or URL
3. Optional- Configure Data
4. Configure Remote Path
5. Optional- Configure syncDir
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

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

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

Upload String as File with SFTP (key-based auth) API on New Message In Channels from Slack API

Slack + SFTP (key-based auth)

Try it

Upload String as File with SFTP (key-based auth) API on New Message in Channel from Discord Bot API

Discord Bot + SFTP (key-based auth)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Upload File on SFTP (key-based auth)

Description:Uploads a file or string in UTF-8 format to the SFTP server. [See the documentation](https://github.com/theophilusx/ssh2-sftp-client#org99d1b64)

Version:0.4.1

Key:sftp-upload-file

View on GitHub

Code#

import app from "../../sftp.app.mjs";
import {
  ConfigurationError, getFileStream,
} from "@pipedream/platform";

export default {
  key: "sftp-upload-file",
  name: "Upload File",
  description: "Uploads a file or string in UTF-8 format to the SFTP server. [See the documentation](https://github.com/theophilusx/ssh2-sftp-client#org99d1b64)",
  version: "0.4.1",
  type: "action",
  props: {
    app,
    file: {
      propDefinition: [
        app,
        "file",
      ],
    },
    data: {
      type: "string",
      label: "Data",
      description: "Upload a string in UTF-8 format to the remote server.",
      optional: true,
    },
    remotePath: {
      type: "string",
      label: "Remote Path",
      description: "The path on the sftp server for store the data. e.g. `./uploads/my-file.txt`",
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.data && !this.file) {
      throw new ConfigurationError("Either `Data` or `File Path or URL` must be provided.");
    }

    const buffer = this.file ?
      (await getFileStream(this.file)) :
      Buffer.from(this.data);

    const response = await this.app.put({
      buffer: buffer,
      remotePath: this.remotePath,
    });

    $.export("$summary", "Successfully uploaded data stream");
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
SFTP (key-based auth)	`app`	`app`	This component uses the SFTP (key-based auth) app.
File Path or URL	`file`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`).
Data	`data`	`string`	Upload a string in UTF-8 format to the remote server.
Remote Path	`remotePath`	`string`	The path on the sftp server for store the data. e.g. `./uploads/my-file.txt`
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.

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.