Test with SSH activities

Relevant for: API testing

This topic describes the SSH activities available in the Toolbox pane for API tests.

Overview

Use SSH activities to run commands on remote servers and manage files and directories over SSH.

SSH activities are available in the Toolbox pane under the SSH node in Standard Activities.

Configure each activity's properties in the Properties pane as displayed in the UI. Property names and required fields can vary by activity.

For SSH file and directory activities, remote paths must be specified as full paths.

For local paths, specify a full path or a path that is relative to the test folder.

You can link a step to a data source using the Link to data source button in the Value field of activity properties. For details, see Assign data to API test/component steps.

SSH activities

The Toolbox offers several different SSH activities you can use in your API test.

Activity Description
SSH Execute Command Executes a shell command on a remote SSH server and returns the output.
SSH Upload (SCP) Uploads a local file to a remote SSH server via SCP.
SSH Download (SCP) Downloads a file from a remote SSH server to a local path via SCP.
SSH Rename Renames a file or directory on a remote SSH server via SFTP.
SSH File Delete Deletes a file on a remote SSH server via SFTP.
SSH File Get Size Gets the size of a file on a remote SSH server via SFTP.
SSH Directory Delete Deletes a directory on a remote SSH server via SFTP. Use the Recursive option in the activity input properties when you need to delete nested content.
SSH Directory Create Creates a directory on a remote SSH server via SFTP.
SSH Directory Get Content Lists the contents of a directory on a remote SSH server via SFTP.

The SSH Execute Command activity

Use SSH Execute Command when you need to run shell commands as part of your API test flow.

This enables you to perform remote administration tasks, trigger scripts, or verify server state directly from the test.

To use SSH Execute Command:

  1. In the Toolbox pane, under Standard Activities > SSH, add SSH Execute Command to the canvas.
  2. In the Input/Checkpoints tab of the Properties pane, set the SSH connection values. To enter a Private Key Path, use the General properties tab.
  3. Specify the command text to run on the remote server.
  4. Run the test and validate the command result in the run results.

Typical SSH test flow

Build an API test with SSH activities:

  1. Create an API test or open an existing API test, and expand Standard Activities > SSH in the Toolbox pane.
  2. Add one or more SSH activities to the test flow canvas.
  3. Set each activity's connection and path values in the Input/Checkpoints tab of the Properties pane. To enter a Private Key Path, use the General properties tab.
  4. Set additional options in the Properties tab, as required for the activity you selected.
  5. Run the test and review outputs and checkpoints in the run results.