Installing the REST API

You can install the REST API on the same computer as the Helix ALM Server or another computer. The Helix ALM REST API Server, which is a Node.js web server application, is installed. The server runs as a service that automatically starts when the computer hosting it starts.

All REST API files are installed in the helix-alm-rest-api directory in the Helix ALM application directory (e.g., C:\Program Files\Perforce\Helix ALM\helix-alm-rest-api).

See the installation help for more information about installing the Helix ALM and the REST API.

Before you install

Before you install the REST API, you need the following information:

Server address and port number for the computer hosting the Helix ALM Server. If the Helix ALM Server is not yet installed, you also need to install it. The API requires Helix ALM 2017.2 or later.
Server address and port number for the computer that will host the Helix ALM REST API Server. The default ports are 8443 for HTTPS and 8900 for HTTP. The server is installed to use HTTPS by default. To use HTTP, you must update the configuration file after installation. See Editing the configuration file.

Running the installer

Download and run the Helix ALM installer. Make sure you select or enter the following information on the installer screens:

Installation Type—Select Helix ALM REST API.
Helix ALM Configuration—Enter the IP address or domain name of the server computer hosting the Helix ALM Server and the port number. The default port is 99 (Windows) or 1566 (Linux).
REST API Configuration—Enter the IP address or domain name of the server computer hosting the Helix ALM REST API and the port number. The default port is 8443 (HTTPS) or 8900 (HTTP).

After installation

When installation is complete, the Helix ALM REST API Server automatically starts.