SSH (key-based auth)

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

Go to site
Explore
/
Apps
/
SSH (key-based auth)

SSH (key-based auth) API Integrations

Build and run workflows using the SSH (key-based auth) API. Use 1000s of source-available triggers and actions across 2,100+ apps. Or write custom code to integrate any app or API in seconds.

Overview

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.

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()
  },
})

Choose an API to Connect with SSH (key-based auth) API

1
-
24
of
2,100+
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.
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.
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 models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Example Use Cases

  • Automated Deployment: Trigger a workflow on Pipedream when your code repository (like GitHub) senses a new commit to the master branch. The workflow would initiate an SSH session to your production server and pull the latest code changes, ensuring continuous deployment without manual intervention.

  • Scheduled Server Maintenance: Set up a scheduled workflow in Pipedream that SSHs into your server to perform routine maintenance such as package updates, cleaning temp directories, or backing up databases. This could be paired with a notification service like Slack to inform your team when maintenance tasks have been completed.

  • Real-time Server Monitoring and Alerts: Create a Pipedream workflow that periodically SSHs into your server to check system health, like disk space or running services. If it detects an issue, it could send an alert through an app like PagerDuty or send a detailed report to an email via SendGrid, enabling prompt response to potential problems.

Execute a Command with SSH (key-based auth) API on New Created User from Namely API
Namely + SSH (key-based auth)
 
Try it
Execute a Command with SSH (key-based auth) API on New Requests from HTTP / Webhook API
HTTP / Webhook + SSH (key-based auth)
 
Try it
Execute a Command with SSH (key-based auth) API on New Item in Feed from RSS API
RSS + SSH (key-based auth)
 
Try it
Execute a Command with SSH (key-based auth) API on New Message from Discord API
Discord + SSH (key-based auth)
 
Try it
Execute a Command with SSH (key-based auth) API on New Message In Channels from Slack API
Slack + SSH (key-based auth)
 
Try it
Execute a Command with the SSH (key-based auth) API

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

 
Try it

Authentication

SSH (key-based auth) uses API keys for authentication. When you connect your SSH (key-based auth) account, Pipedream securely stores the keys so you can easily authenticate to SSH (key-based auth) APIs in both code and no-code steps.

Enter the hostname and port 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 SSH (password-based auth) app, instead.