SFTP (Legacy)

Transfer files securely between systems using the Secure File Transfer Protocol (SFTP).

This reference documentation is for the Legacy SFTP book. Please refer to the latest version here.

Prerequisites

In order to use the Legacy SFTP book, you need to first add it to your agent.

Adding the Book

1. Navigate to Books → All Books.

2. Click SFTP Client (Legacy).

3. Click on Add Connection.

4. Enter your credentials when prompted:

   1. Username

   2. Password

   3. Host

   4. Port

Automation Procedures

Downloading Files

To download a file using SFTP, use the following syntax:

connect to sftp with
    the host is "sftp.example.com"
    the port is 22
    the username is "user"
    the password is "password"
get a file from sftp with
    the remote path is "/path/to/remote/file.txt"

Uploading Files

Basic Upload

To upload a file to an SFTP server, use the following syntax:

connect to sftp with
    the host is "sftp.example.com"
    the username is "user"
    the password is "password"
get the file
dump the file to sftp

Upload with Specified Remote Path

To upload a file to a specific path on the SFTP server, use the following syntax:

connect to sftp with
    the host is "sftp.example.com"
    the username is "user"
    the password is "password"
get the file
the remote path is "/uploads/myfile.txt"
dump the file to sftp

In this example, the file is uploaded to the specified remote path.