Integrate the SSH (key-based auth) API with the Filter API

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

Popular SSH (key-based auth) and Filter Actions#

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

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

Try it

Continue execution if a condition Is met with the Filter API

Continue workflow execution only if a condition is met

Try it

End execution if a condition is met with the Filter API

End workflow execution if a condition is met

Try it

Overview of SSH (key-based auth)#

The SSH (Secure Shell) key-based authentication API allows you to execute commands on a remote server securely. With Pipedream, leverage this capability to automate server management tasks, execute deployment scripts, or gather data from your server infrastructure. By integrating with other apps on Pipedream, you can create seamless workflows that trigger actions on your servers in response to various events.

Connect SSH (key-based auth)#

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 Filter#

The Filter API in Pipedream allows for real-time data processing within workflows. It's designed to evaluate data against predefined conditions, enabling workflows to branch or perform specific actions based on those conditions. This API is instrumental in creating efficient, targeted automations that respond dynamically to diverse datasets. Using the Filter API, you can refine streams of data, ensuring that subsequent steps in your Pipedream workflow only execute when the data meets your specified criteria. This cuts down on unnecessary processing and facilitates the creation of more intelligent, context-aware systems.

Connect Filter#

export default defineComponent({
  async run({ steps, $ }) {
    let condition = false
    if (condition == false) {
      $.flow.exit("Ending workflow early because the condition is false")
    } else {
        $.export("$summary", "Continuing workflow, since condition for ending was not met.")
    }
  },
})