Node API Setup

To set up the Aspera Node API, follow the instructions below. These instructions assume that you have already installed Enterprise Server.

  1. Create a Node API username/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 user/password and associates it with a file transfer user, aspera_user_1, which you will create in the next step. The Node API credentials can then be used to create nodes. 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
  2. Create the file transfer user.
    The file transfer user authenticates the actual ascp transfer, and must be an operating system account on the node. To create a transfer user—for example, aspera_user_1—run the following command:
    # useradd aspera_user_1

    After you've created the operating system account, set up this user in Enterprise Server. For instructions on setting up a user, see Setting Up Users.

    Note: The file transfer user requires a docroot. After setting a user's docroot, be sure to perform a reload, as described in aspera.conf for Nodes.
  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 aspera.conf for Nodes. For information on maintaining and generating a new SSL certificate, see Setting up SSL for your Nodes.