Set up HST Server for
Node API
HST Server must
be configured in order to use the Aspera Node API. You can use the
asnodeadmin tool to set up the server and manage the Node API. The Node API
uses a Redis database, which can be backed up and restored in different ways, depending on what
information you need to preserve.
Overview: Aspera Node API
The Aspera Node API is a feature of HST Server that provides a REST API for full programmatic control of the Aspera transfer server environment. A daemon, asperanoded , provides node-specific services such as browsing, searching, creating and deleting files and directories, and setting up transfers over HTTP or HTTPS.
Node API Setup
The Aspera Node API comes with your installation of HST Server . To use it, you must configure your system and create Node API credentials.
Node Admin Tool
Use the asnodeadmin tool to manage (add, modify, delete, and list) Node API users. Root privileges are required.
Configuring the IBM Aspera NodeD Service
The IBM Aspera NodeD Service handles HTTP/HTTPS requests to HST Server . You can configure server settings including the hostname, HTTP/HTTPS ports, the address and port of the Redis database, and SSL certificates.
Securing the Node Service Behind a Proxy
If your HST Server must expose asperanoded to the internet, such as when setting it up as a IBM Aspera on Cloud (AoC ) node, Aspera strongly recommends protecting it with a reverse proxy and keeping the SSL ciphers up-to-date (see https://cipherli.st/ for examples). (CIM-1694). Normally, asperanoded runs on port 9092, but nodes that are added to AoC must have asperanoded run on port 443, the standard HTTPS port for secure browser access. Configuring a reverse proxy in front of asperanoded provides additional protection (such as against DOS attacks) and resource handling for requests to the node's 443 port.
Backing up and Restoring the Node User Database Records
These instructions describe how to back up and restore your Node API user data up to the time of the backup operation. To backup the entire database, see Backing up and Restoring a Node Database .
Backing up and Restoring Access Keys (Tenant Data)
Access keys can be backed up and restored by using the asnodeadmin tool. Only master access keys can be directly backed up, not sub-access keys, but backing up a master access key backs up all associated sub-access keys, too.
Backing up and Restoring a Node Database
These instructions describe how to back up and restore the entire Redis database of a node, which includes Node API users, their access keys, and transfer history. If your transfer server is an IBM Aspera on Cloud (AoC ) node, migrate AoC data from one node to another by backing up the Redis database on the original node and restoring the database on a new node.
Setting up SSL for your Nodes
The Aspera Node API provides an HTTPS interface for encrypted communication between nodes (on port 9092, by default). For example, if you are running the IBM Aspera Faspex web UI or the IBM Aspera Shares web UI on one computer, you can encrypt the connection (using SSL) with your transfer server or file-storage node on another computer. HST Server nodes are preconfigured to use Aspera's default, self-signed certificate (aspera_server_cert.pem
). You might need to create a new certificate or install a valid, signed certificate, such as when you are configuring HST Server as a IBM Aspera on Cloud node.
Installing SSL Certificates
Aspera strongly recommends installing valid, signed SSL certificates on your HST Server . The SSL certificates are uasperanoded and asperahttpd .