View as Markdown
SSH (key-based auth) icon

SSH (key-based auth) ACTION

Execute a Command

Executes a command on a remote device. See SSH lib docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SSH (key-based auth) account once, then configure and run Execute a Command from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ssh-execute-command",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ssh: { authProvisionId: "apn_xxxxxxx" },
    command: "Command",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Execute a Command inputs
Property Type Description
command Command string
Command that will be executed
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ssh-execute-command
Version
0.0.3
App
SSH (key-based auth)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes