Aspera transfer servers must be configured to support Node API requests. Aspera SaaS applications and cloud instances are pre-configured to support Node API. These include:

  • Aspera on Cloud
  • Aspera on Cloud transfer service
  • Aspera Transfer Cluster Manager nodes
  • Aspera on Demand

Self-managed High-Speed Transfer Server nodes must be configured to allow Node API requests through the firewall and to support specific logging.

Required Configuration for the Node API on HST Server

  1. The node’s hosts file must contain an entry for 127.0.0.1 localhost. The hosts file can be found in /etc/hosts on UNIX-like nodes and C:\Windows\System32\drivers\etc\hosts on Windows nodes.

  2. The node’s firewall must allow HTTP or HTTPS connections on ports 9091 or 9092, if using the Aspera defaults, or the HTTP/HTTPS ports that are configured in aspera.conf. For more information, see “Set up for Node API” in the IBM Aspera High-Speed Transfer Server Admin Guide.

  3. If you want to query transfers by using GET /ops/transfers or to retrieve usage data by using GET /usage, enable activity logging on the node by running the following command:

    asconfigurator -x "set_server_data;activity_logging,true"
  4. If you want to query events by using GET /events, enable activity event logging on the node by running the following command:

    asconfigurator -x "set_server_data;activity_event_logging,true"

    As of version 3.8.0, activity_event_logging can be configured in individual access keys and overrides the setting on the node. For more information, see “Access Keys” in the IBM Aspera High-Speed Transfer Server Admin Guide. If activity_event_logging is enabled for the access key, any Node API events associated with that access key are logged even if the node setting is false. If it is disabled for the access key, events are not logged for the access key even if activity_event_logging is enabled on the node.

  5. Restart the Aspera Noded service to activate your changes:

    • Linux:
      $ sudo service asperanoded restart
    • Windows:

      Go to Control Panel > Administrative Tools > Services, click Aspera NodeD, and click Restart.

    • macOS:
      $ sudo launchctl stop com.aspera.asperanoded
      $ sudo launchctl start com.aspera.asperanoded