Install the API Gateway

There are several ways to install an API Gateway:

  • During installation of a either a Single computer or a Custom (distributed) XProtect VMS, using the XProtect VMS product installer.

  • After installation of a XProtect VMS, using the API Gateway installer downloaded from the management server's Administrative Installation Page.

Install the API Gateway using the XProtect VMS product installer

The API Gateway is included by default in both Single computer and Custom installations.

The API Gateway will be installed on the same host as the management server and with the same server certificate if you enable encryption.

Install the API Gateway using the API Gateway installer

The management server has a built-in public installation web page. From this web page, administrators and end-users can download and install additional system components. For example, if you didn't initially install an API Gateway, you can install it later.

  1. From the computer where management server is installed, go to the management server's download web page. In Windows' Start menu, select Milestone > Administrative Installation Page and write down or copy the address for later use when installing the system components on the other computers. The address is typically http://[management server address]/installation/Admin/default-en-US.htm.

  2. Log into the computer where you want to install the API Gateway.

  3. Open the management server's download web page in a web browser.

  4. Locate the API Gateway Installer section, and select All Languages to start downloading the installer. Save the installer first, or run it directly from the web page.

  5. Choose installation language.

  6. Accept license terms.

  7. Enter the management server address. Use HTTPS if the management server is configured to be secure.

  8. Select the web site on the local IIS to use with the API Gateway, usually the Default Web Site.

  9. If the management server is configured to be secure, you must select a server certificate for the API Gateway host. If you are installing the API Gateway on the host of the management server, select the server certificate you used when installing XProtect VMS.

  10. Select the service account for the API Gateway, usually the Network Service account.

  11. Select file location and product language.

  12. Select Install.