← SFTP (password-based auth) + Data Stores integrations

List keys with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API

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

Trigger workflow on
New Remote Directory Watcher from the SFTP (password-based auth) API
Next, do this
List keys with the Data Stores API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New Remote Directory Watcher trigger
    1. Connect your SFTP (password-based auth) account
    2. Configure timer
    3. Configure Root directory
    4. Configure Maximum watcher depth
  3. Configure the List keys action
    1. Connect your Data Stores account
    2. Configure Data Store
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)
Version:0.0.1
Key:sftp_password_based_auth-watch-remote-directory

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

Trigger Code

import sftpApp from "../../sftp_password_based_auth.app.mjs";
import base from "../../../sftp/sources/watch-remote-directory/watch-remote-directory.mjs";

export default {
  ...base,
  key: "sftp_password_based_auth-watch-remote-directory",
  name: "New Remote Directory Watcher",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.0.1",
  type: "source",
  props: {
    ...base.props,
    sftpApp,
  },
  methods: {
    ...base.methods,
    async connect() {
      return await this.sftpApp.connect();
    },
  },
};

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.
LabelPropTypeDescription
SFTP (password-based auth)sftpAppappThis component uses the SFTP (password-based auth) app.
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
Root directoryrootDirectorystring

Root directory to be watched. example: /public

Maximum watcher depthmaxDepthinteger

Watch all subdirectories within of the root directory, considering the selected maximum depth.

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

About SFTP (password-based auth)

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

Action

Description:List all keys in your [Pipedream Data Store](https://pipedream.com/data-stores/).
Version:0.0.2
Key:data_stores-list-keys

Data Stores Overview

With the Data Stores API, you can build applications that:

  • Store data for later retrieval
  • Retrieve data from a store
  • Update data in a store
  • Delete data from a store

Action Code

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

export default {
  key: "data_stores-list-keys",
  name: "List keys",
  description: "List all keys in your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
  },
  async run ({ $ }) {
    const keys = await this.dataStore.keys();
    if (keys.length > 0) {
      $.export("$summary", `Found ${keys.length} key(s).`);
    } else {
      $.export("$summary", "No keys found.");
    }
    return keys;
  },
};

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.

LabelPropTypeDescription
Data StoresappappThis component uses the Data Stores app.
Data StoredataStoredata_store

Select an existing Data Store or create a new one.

Action Authentication

The Data Stores API does not require authentication.

About Data Stores

Use Pipedream Data Stores to manage state throughout your workflows.

More Ways to Connect Data Stores + SFTP (password-based auth)

Add or update multiple records with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Data Stores
 
Try it
Add or update a single record with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Data Stores
 
Try it
Delete All Records with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Data Stores
 
Try it
List Records with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Data Stores
 
Try it
Delete a single record with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + Data Stores
 
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
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
Add or update a single record with the Data Stores API

Add or update a single record in your Pipedream Data Store.

 
Try it
Add or update multiple records with the Data Stores API

Add or update multiple records to your Pipedream Data Store.

 
Try it
Append to record with the Data Stores API

Append to a record in your data store Pipedream Data Store. If the record does not exist, a new record will be created in an array format.

 
Try it
Check for existence of key with the Data Stores API

Check if a key exists in your Pipedream Data Store or create one if it doesn't exist.

 
Try it

Explore Other Apps

1
-
12
of
1400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
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.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
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.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
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 apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
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.
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.