Node API Setup

To set up the Aspera Node API, follow the instructions below. These instructions assume that you have already installed Point-to-Point.

  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.
    > asnodeadmin -a -u node_api_username -p node_api_passwd -x aspera_user_1

    Adding, modifying, or deleting a node user triggers automatic reloading of the configuration and license files, as well as the user database.

  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. Create a transfer user—for example, aspera_user_1—on your operating system (Control Panel > User Accounts). (Creating a user account requires administrator permissions.)
    Note: After creating a Windows user account, log in as that user as least once in order for Windows to set up the user's home folder—for example, C:\Users\aspera_user_1. Once the user's home folder has been created, log back in as an administrator and continue the steps below.

    After you've created the operating system account, set up this user in Point-to-Point. 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.