Node API Setup

The Aspera Node API comes with your installation of Enterprise Server. To use it, you must set up a Node username and password and configure your server.

  1. Create an Aspera transfer user.
    The Aspera transfer user authenticates the actual ascp transfer, and must be an operating system user on the node. If the operating system user does not exist, create the user.Create a user account—for example, aspera_user_1—by running the following command:
    # useradd aspera_user_1

    Configure the operating system user in Enterprise Server to make it an Aspera transfer user. For instructions, see Setting Up Transfer Users.

    Note: The Aspera transfer user must have a docroot configured (see aspera.conf - File System). After setting the user's docroot, restart the Node service, as described in Configuring the Server for the Node API.
  2. Configure the Aspera transfer user with a Node API username and password.
    Aspera's Web applications authenticate to the remote node service using a Node API username and password. The following command creates a Node API username and password, and associates it with a file transfer user, in this example aspera_user_1. Different nodes may use different Node API username-password pairs.
    # /opt/aspera/bin/asnodeadmin -a -u node_api_username -p node_api_passwd -x aspera_user_1
  3. (Optional) Change HTTPS port and/or SSL certificate.
    The Aspera Node API provides an HTTPS interface for encrypted communication between node machines (on port 9092, by default). To modify the HTTPS port, see Configuring the Server for the Node API. For information on maintaining and generating a new SSL certificate, see Setting up SSL for your Nodes.