Quick start guide to setting up an Aspera Node API User on Windows


The Node API is part of Enterprise Server and provides a RESTful interface for remote file operations and transfer initiations. Aspera web applications authenticate to a remote node service (a remote Enterprise Server) using a Node API username and password. Use the following instructions to set up a Node API user on Windows.


1. First, create the transfer user that your Node API user will be associated with. The transfer user is an account on the operating system and authenticates the actual ascp transfers.

To create a new user on Windows, go to Start > Control Panel. Under the User Accounts and Family Safety section, click Add or remove user accounts. On the resulting page, click Create a new account.

2. Give the SSH public key that matches the Aspera Connect plugin private key to your transfer user. The public key is found at the following location:

  • C:\Program Files (x86)\Aspera\Enterprise Server\var\aspera_id_dsa.pub

Create a .ssh directory in your transfer user’s home directory if it does not exist:

md .ssh

Create a file named authorized_keys in the .ssh directory if it does not exist, and copy the contents of the aspera_id_dsa.pub public key to it. You can do so with the following command:

type C:\Program Files (x86)\Aspera\Enterprise Server\var\aspera_id_dsa.pub >> authorized_keys

Verify the permissions by right clicking the .ssh folder and selecting Properties. Click the Security tab and make sure read, write and execute permissions are set (full control).

3. Set a docroot for your transfer user. Choose or create a directory that your transfer user owns, then use asconfigurator to set the docroot to the path of that directory. Use the following command, replacing transfer_user and C:\path\to\docroot with your transfer username and docroot path:

asconfigurator -x "set_user_data;user_name,transfer_user;absolute,C:\path\to\docroot"

4. Configure server and token settings.

Use the following asconfigurator commands to configure the server, replacing example.com with the IP address or domain name of your server:

asconfigurator -x "set_central_server_data;persistent_store,enable"
asconfigurator -x "set_server_data;server_name,example.com"

Use the following asconfigurator commands to configure token settings, replacing your_token with a long string of random characters (at least 20 recommended), and transfer_user with the transfer username:

asconfigurator -x "set_node_data;token_encryption_key,your_token"
asconfigurator -x "set_user_data;user_name,transfer_user;authorization_transfer_out_value,token"
asconfigurator -x "set_user_data;user_name,transfer_user;authorization_transfer_in_value,token"

5. Finally, create the Node API username and password with the following command:

asnodeadmin.exe -a -u node_api_username -p node_api_password -x transfer_user

6. Restart asperacentral and asperanoded.

Go to Start > Control Panel and select Administrative Tools. Click Services.

Locate Aspera Central and Aspera NodeD and restart the services by clicking Restart on the left.

Powered by Zendesk