SSH (key-based auth)

Use the Secure Shell protocol to execute commands on a remote server using a private key

Integrate the SSH (key-based auth) API with the Data Stores API

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

Execute a Command with the SSH (key-based auth) API

Executes a command on a remote device. See SSH lib docs here

 
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

Overview of SSH (key-based auth)

The Secure Shell (SSH) API is an powerful tool for securely connecting to
remote systems over a network, allowing users to easily and securely access
their systems or services. This API is useful for a variety of tasks including
data transfer and remote system management.

Key-based authentication is a way of validating the identity of the client to
the server. It works by generating and exchanging a digital key that must match
in order for the user to access the server. This provides an extra layer of
security, as it is much harder to guess a digital key than a user password.

With the SSH (key-based auth) API, you can use key-based authentication to
create an encrypted, authenticated channel between two computers. This can be
used for securely accessing services, such as:

  • Securing server access
  • Sharing data with other systems
  • Managing remote systems
  • Transferring large files between computers
  • Encrypting communication between two computers

Connect SSH (key-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
31
32
33
34
35
module.exports = defineComponent({
  props: {
    ssh: {
      type: "app",
      app: "ssh",
    }
  },
  async run({steps, $}) {
    const SSH2Promise = require('ssh2-promise')
    
    const { 
      host, 
      port,
      username, 
      privateKey,
    } = this.ssh.$auth
    
    const ssh = new SSH2Promise({
      host,
      port,
      username,
      privateKey,
    })
    
    await ssh.connect()
    console.log("Connection established")
    
    // Replace this with the command you'd like to run
    const resp = await ssh.exec("whoami")
    console.log(resp)
    
    await ssh.close()
  },
})

Overview of Data Stores

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

Connect Data Stores

1
2
3
4
5
6
7
8
9
10
11
export default defineComponent({
  props: {
    myDataStore: {
      type: "data_store",
    },
  },
  async run({ steps, $ }) {
    await this.myDataStore.set("key_here","Any serializable JSON as the value")
    return await this.myDataStore.get("key_here")
  },
})