REST API integrations

SFTPPlus MFT provides HTTP-based integration points for file transfers, user authentication, and event delivery. These APIs connect file transfer workflows with your applications and services. They are not an administrative API for configuring or managing SFTPPlus.

Transfer files over HTTPS ​

The SFTPPlus HTTPS service exposes a RESTful JSON API for working with files. Applications can list folders, download or upload files, create folders, and remove files using standard HTTP methods. Access is controlled by the same accounts, groups, permissions, and authentication policies used for other file transfer protocols.

See the HTTP and HTTPS protocol page for an example request. The HTTP file transfer service API documentation describes all operations and response formats.

Delegate user authentication to an HTTP API ​

SFTPPlus can authenticate file transfer users through an HTTP endpoint operated by your organization. When a user connects, SFTPPlus sends the credentials to that endpoint and uses its response to reject the login or create the user's access configuration. This supports passwords, SSH keys, and TLS certificates across the relevant file transfer protocols.

Read about HTTP API authentication and how it can connect SFTPPlus to an existing identity service. The development API solution page compares this approach with other extension options.

Send events to other applications ​

An HTTP POST event handler can send SFTPPlus events to webhooks and other HTTP services. You can select the events to publish and send their details as JSON, XML, or content generated from a custom template. This can notify another application when a file arrives, a transfer fails, or another monitored operation occurs.

See the HTTP POST event handler documentation for configuration and request examples. For common integration patterns, see the HTTP webhooks solution page.

Configure and manage SFTPPlus ​

Use the Web Manager JSON-RPC API to configure and manage SFTPPlus MFT from your applications. It supports the same operations as the Web Manager browser interface, including managing users and starting or stopping services. The admin-shell command-line tool uses the same API for administration from scripts and terminals. For declarative deployments and version-controlled configuration, use the .INI configuration file.