Creating a pull Watch Folder with the API
These instructions describe how to create a pull Watch Folder by using the Watch Folder API.
You can also create and manage Watch Folders from the command line (Creating a pull Watch Folder with aswatchfolderadmin) or by using IBM Aspera Console.
When you create a Watch Folder, a Watch service subscription is automatically created to monitor the source directory. In the rare case that the subscription is somehow deleted or impaired, Watch Folders automatically creates a new subscription; however, the new subscription does not retain the file change history and all files in the source directory are retransferred.
Restrictions on all Watch Folders
- Only local to remote (push) and remote to local (pull) configurations are supported. Remote to remote and local to local are not supported.
- Growing files are only supported for local sources (push Watch Folders) and must be authenticated by a transfer user (password or SSH key file). The transfer user cannot be restricted to aspshell and the source cannot be in object storage. Growing files are only supported for local sources and nonobject storage-based destinations.
- Source file archiving is not supported if the Watch Folder source is in object storage.
- IBM Aspera Shares endpoints must have version Shares version 1.9.11 with the Watch Folder patch or a later version.
Restrictions on Pull Watch Folders
- The remote server must be running HSTS or HSTE.
- Pull Watch Folders must be authenticated with an access key ID and secret, a Node API username and password, SSH keys, SSH username and password, or IBM Aspera Shares credentials. (V4.4.3)
- Pull Watch Folders that use Node API authentication cannot be authenticated with a Node API user whose associated transfer user is configured with a restriction (the Watch Folder status is reported as impaired). Edit the transfer user's configuration to use a docroot, restart asperanoded, and the Watch Folder recovers automatically.
- Pull Watch Folders cannot use IBM Aspera on Cloud (including IBM Aspera on Cloud transfer service nodes) or IBM Aspera Transfer Cluster Manager nodes as the remote source.
- Pull Watch Folders do not support growing files.
You can manage Watch Folders by using the API. For more information, see
Managing Watch Folders with the API.