| Watch Folders and the Aspera Watch Service |
178
},
"watchd" : {
"scan_period":"30m",
"identifier" : "root"
}
}
Top Level Configuration
Watch Folders supports transfers between a local server and a remote server. For the local server, Watch Folders
requires only the local path, whether it is the source or target. For the remote server, Watch Folders requires the host
address, port for authentication, and authentication credentials. In the following example, the source is remote and the
target is local.
Note:
The header
"X-aspera-WF-version:2017_10_23"
is required when submitting POST, PUT, and GET
requests to /v3/watchfolders on servers that are version 3.8.0 or newer. This enables Watch Folders to parse the JSON
"source" and "target" objects in the format that was introduced in version 3.8.0.
{
"source": {
"path": "
path
",
"location": {
"type": "REMOTE",
"host": "
host
",
"port":
port
,
"authentication": {
"type": "SSH|NODE_BASIC",
"user": "
username
",
"pass": "
password
",
"keypath": "
key_file
",
"fingerprint: "
ssh_fingerprint
"
}
}
},
"target": {
"path": "
path
"
},
"id":"
watchfolder_id
",
"cool_off":"30s",
"snapshot_creation_period":"10s",
...
}
Field
Description
Default
path
The source or target directory.
Required
.
Local path:
The path is relative to the docroot of the transfer user
associated with the node username. If the transfer user is configured
with a restriction, the path is the absolute or UNC path.
Remote path:
For access key authentication, the path is relative
to the storage specified in the access key. For SSH and Node
API user authentication, the path is relative to the user's docroot,
configured, or the absolute or UNC path if the user is configured
with a restriction. For IBM Aspera Shares authentication, the path is
the share name and, optionally, a path within the share.
When asperawatchd detects a new file in the source directory,
asperawatchfolderd starts an
ascp
session to transfer the file to
N/A
