Axway SecureTransport User icon

Axway SecureTransport User

Interact with Axway SecureTransport End-User API v2.0 — file operations, transfers, and account management.

Transfer → Pull

AI-generated

Summary

Initiate a pull file transfer from a specified Axway SecureTransport transfer site and store the files in a specified local directory.

Inputs

  • Site Name (required) — The name of the remote transfer site to pull files from.
  • Destination Directory — The local directory path where the pulled files will be saved; defaults to '/'.
  • Pull Options — Additional options including the transfer profile to use and the maximum number of parallel site pulls.

Output shape

a single JSON object representing the initiated pull transfer operation's response data

The output includes details such as transfer status or identifiers returned by the SecureTransport API after initiating the pull. It is a single record per execution.

Examples

Example 1: Pull files from a remote site and save to local inbox

Set 'Site Name' to the remote site, 'Destination Directory' to '/inbox', and optionally specify 'Pull Options' like 'Transfer Profile' and 'Max Parallel Pulls'. The operation triggers file retrieval from the remote site to the specified local directory.

Links

Discussion