Upload String as File with SFTP (password-based auth) API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for SFTP (password-based auth), Schedule and 1000+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and SFTP (password-based auth) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Upload String as File action
1. Connect your SFTP (password-based auth) account
2. Configure data
3. Configure Remote Path
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

With Schedule - A trigger provided by Pipedream - You can easily build
automated workflows that run on regular times or intervals. Some examples of
things that you can build using the Schedule API include:

Automated data retrieval from a third-party service, like pulling stats from
your Salesforce account on a set schedule.
Uploading new data sets to a database with a predetermined interval.
Automatic emails to customers or leads at a certain time of the day.
Automating data analysis based on a set schedule.
Automatically optimizing social media postings according to a specified
timeline.
Updating webpages at a certain interval with newly available content.
Re-running reports on a periodic basis.
Refreshing a cache of data at a given frequency.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Upload String as File on SFTP (password-based auth)

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

Version:0.1.1

Key:sftp_password_based_auth-upload-file

View on GitHub

SFTP (password-based auth) Overview#

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

Action Code#

// legacy_hash_id: a_YEikdQ
import Client from "ssh2-sftp-client";

export default {
  key: "sftp_password_based_auth-upload-file",
  name: "Upload String as File",
  description: "Uploads a UTF-8 string as a file on an SFTP server",
  version: "0.1.1",
  type: "action",
  props: {
    sftp_password_based_auth: {
      type: "app",
      app: "sftp_password_based_auth",
    },
    data: {
      type: "string",
      description: "A UTF-8 string to upload as a file on the remote server.",
    },
    remotePath: {
      type: "string",
      label: "Remote Path",
      description: "The path to the remote file to be created on the server.",
    },
  },
  async run({ $ }) {
    const {
      host,
      username,
      password,
    } = this.sftp_password_based_auth.$auth;

    const config = {
      host,
      username,
      password,
    };

    const sftp = new Client();

    await sftp.connect(config);
    $.export("putResponse", await sftp.put(Buffer.from(this.data), this.remotePath));
    await sftp.end();
  },
};

Action Configuration#

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

Label	Prop	Type	Description
SFTP (password-based auth)	`sftp_password_based_auth`	`app`	This component uses the SFTP (password-based auth) app.
data	`data`	`string`	A UTF-8 string to upload as a file on the remote server.
Remote Path	`remotePath`	`string`	The path to the remote file to be created on the server.

Action 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.