Skip to main content

Cyware Orchestrate

FTP

App Vendor: Cyware

App Category: Cyware Product

Connector Version: 1.0.2

API Version: ftplib 3.8

About App

The FTP app allows security teams to integrate with the FTP enterprise application to read/write/download/list directories or files.

The FTP app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Get a List of Directories

This action retrieves the list of directories and files from a working directory in the FTP application.

Download a Remote File

This action downloads a file from the directory in the FTP application.

Upload a Remote File

This action uploads a file in the remote working directory using the local file path in the FTP application.

Configuration Parameters

The following configuration parameters are required for the FTP app to communicate with the FTP enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL

Enter the FTP server/host base URL.

Example:

"https://ftp.dlptest.com"

Text

Required

Port

Enter the FTP server/host port.

Example:

"24"

Text

Required

Username

Enter the FTP server/host username.

Text

Required

Password

Enter the FTP server/host password.

Password

Required

TLS

Choose to configure TLS for the connection.

Boolean

Optional

Allowed values:

  • true

  • false

Default value:

  • false

Action: Get a List of Directories

This action retrieves the list of directories and files from a working directory in the FTP application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Directory

Enter the directory path.

Example:

"c:\windows\system32"

Text

Optional

Note: By default, the value is the working directory.

Example Request

[
    {
        "directory": "c:\windows\system32"
    }
]
Action: Download a Remote File

This action downloads a file from the directory in the FTP application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Remote File Path

Enter the remote file path.

Example:

"rest-api/data/killroy-upload.txt"

Text

Required

Local File Name

Enter the local file name.

Example:

"system.txt"

Text

Optional

Note: By default, the file name from the remote file path is taken.

Example Request

[
    {
        "remote_filepath": "rest-api/data/killroy-upload.txt",
        "local_filename": "system.txt"
    }
]
Action: Upload a Remote File

This action uploads a file in the remote working directory using the local file path in the FTP application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Local File Path

Enter the local file path.

Example:

"/tmp/0a612a17-0d0b-4261-9b5e-2f490d12bc59/killroy.txt"

Text

Required

Remote File Name

Enter the remote file name.

Example:

"system.txt"

Text

Optional

Note: By default, base file name from the local file path is taken.

Example Request

[
    {
        "local_filepath": "/tmp/0aa17-0d0b-4261-9b5e-2f49/killroy.txt",
        "remote_filename": "system.txt"
    }
]