SFTP

Overview of the SFTP book.

The following documentation is for SFTP v1.4.9 (BDK).

Overview

SFTP (Secure File Transfer Protocol) provides secure file transfer capabilities for safe data exchange. This integration enables automated file uploads, downloads, directory management, and secure data transmission workflows. Ensure secure file operations and maintain data integrity during transfers.

Prerequisites

1. Required Books

The following Book(s) need to be added to your agent so it can learn and understand the automation procedures defined within them:

• SFTP

How to Add the Book(s)

1. Go to Books → All Books.

2. Search for the name of the book and click on it.

3. Click on Install or Add Connection to add the book to your agent.

4. If adding a connection, you'll be prompted for connectivity details.

Connectivity

This section outlines the available methods for connecting to the Book, along with the required configuration details for each.

Connect using Hostname, Port, Username and Password

Connects to an SFTP server.

Label	Description	Type
Hostname	The hostname of the SFTP server.	text
Port	The port of the SFTP server.	text
Username	The username for authentication.	text
Password	The password for authentication.	sensitive

Configuration

The following table details all the available configuration options for this book.

Concept	Description	Type	Default Value
connection timeout	Get the connection timeout value in seconds.	number	(no default)
max retry attempts	Get the value of the attempts.	number	(no default)
base retry delay	Get the value of the base delay.	number	(no default)

Configuration can be set or retrieved as shown in the following examples: