Change the REST URL (Server Instance URL) AgilePoint NX Portal Uses to Connect to AgilePoint Server

To change the REST URL that AgilePoint NX Portal uses to connect to AgilePoint Server (called the server instance URL), do the procedure in this topic. For example, you may want to change this URL to use SSL.

Prerequisites

AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.

Good to Know

The REST URL is the URL for your AgilePoint Server instance.
For more information, refer to Find your AgilePoint Server Instance REST URL.
You can use this utility to configure a single tenant environment. If you want to change the configuration for a multi-tenant environment, contact AgilePoint Professional Services.

How to Start

On the AgilePoint Server machine, open this folder:
(NX Portal installation folder - v9.0 and higher) C:\Program Files\AgilePoint\AgilePointPortalInstance

Procedure

To change the REST URL, do one of these.
- To change the REST URL with the Manage AgilePoint NX Portal Configuration Utility, do this procedure.
  1. Open this folder:
    (NX Portal installation folder - v9.0 and higher) C:\Program Files\AgilePoint\AgilePointPortalInstance\tools
  2. Right-click the file AgilePoint.Portal.Management.exe, and click Run as Administrator.
  3. On the Manage AgilePoint NX Portal Configuration Utility screen, in the Server URL field, enter the value for the REST URL.
    The REST URL must be in this format:
    
    Format:
    
    [Your AgilePoint NX Portal URL]/AgilePointServer
    
    Example:
    
    https://myagilepointnxdomain.com:13490/AgilePointServer
  4. Click Update.
- To change the REST URL manually, do this procedure.
  1. On the AgilePoint Server machine, in a text editor, open the AgilePoint NX Portal configuration file:
    (NX Portal configuration folder - v9.0 and higher) C:\Program Files\AgilePoint\AgilePointPortalInstance\config\web.yaml
  2. In web.yaml, find the agilepointserverurl key and change the value for the REST URL as necessary.
    Format:
    
    "agilepointserverurl": "[Your AgilePoint NX Portal URL]/AgilePointServer",
    
    Example:
    
    "agilepointserverurl": "https://myagilepointnxdomain.com:13490/AgilePointServer",