IBM Aspera HST Admin Manual page 172

A basic pull Watch Folder configuration has the following syntax:
{
"source": {
"path": "source_directory",
"location": {
"type": "REMOTE",
"host": "ip_address",
"port": port,
"authentication": {
"type": "authentication_mode",
"user": "username",
"pass": "password"
}
}
},
"target": {
"path": "target_directory"
},
"watchd": {
"scan_period": "scan_period",
"identifier": "daemon"
}
}
For a full configuration reference, see
Field Description
source path The source directory on the remote server. For SSH and Node
API user authentication, the path is relative to the associated
transfer user's docroot, or the absolute path if the transfer user is
configured with a restriction. For Shares authentication, the path is
the share name and, optionally, a path within the share. For access
key authentication, the path is relative to the storage specified in
the access key.
location type Set "type" to "REMOTE" for the remote server. "type":
"REMOTE" is assumed if "host" is specified.
host The host IP address, DNS, hostname, or URL of the remote file
system. Required. The host can be specified with an IPv4 or IPv6
address. The preferred format for IPv6 addresses is x:x:x:x:x:x:x:x,
where each of the eight x is a hexadecimal number of up to 4 hex
digits. Zone IDs (for example, %eth0) can be appended to the IPv6
address.
port The port to use for authentication to the remote file system. By
default, if the authentication type is SSH, then the SSH port for the
ascp process (the value for tcp_port in the "transport" section)
is used. If the authentication type is NODE_BASIC, 9092 is used.
For Shares, IBM Aspera Transfer Cluster Manager, or IBM Aspera
on Cloud endpoints, enter 443.
authentication type How Watch Folders authenticates to the remote server. Pull Watch
Folders must use NODE_BASIC and authenticate with a Node API
Watch Folder JSON Configuration File Reference
| Watch Folders and the Aspera Watch Service | 172
on page 175.
Default
N/A
"REMOTE"
N/A
If authentication
type is SSH,
then default is
the value for
tcp_port in the
"transport" section
(default: 22). If
authentication type
is NODE_BASIC,
then default is 9092.
NODE_BASIC