Upgrading the API Gateway

An API Gateway that has been installed on the same host as the management server will be upgraded when the management server is upgraded. For API Gateway instances installed on other hosts, you must ensure that each API Gateway instance is upgraded right after the management server upgrade.

Beginning with Milestone XProtect VMS 2023 R3, at least one API Gateway must be available in an XProtect VMS site, and the versions of each API Gateway instance must match the management server version.

For convenience, install an API Gateway on the same host as the management server. This is the default in both Single computer and Custom installations and is mandatory in Milestone XProtect VMS 2024 R2 and later.

List instances of the API Gateway

If you don't already know whether there are instances of the API Gateway installed on other hosts than the management server host, you can use the Management Client to find out.

  1. In Management Client, select Tools > Registered Services....

  2. In the Add/Remove Registered Services dialog, locate instances of type Gateway Service.

  3. You'll find the corresponding hostname in the URLs column.

If you have instances of the API Gateway installed on other hosts, you'll have to upgrade those using the API Gateway installer, preferably right after upgrading the management server.

Upgrade or install the API Gateway using the XProtect VMS Products installer

Upgrade a Single computer installation

The API Gateway has been mandatory in Single computer installations since the introduction of the API Gateway in XProtect VMS 2022 R1.

  • If this is the only instance of the API Gateway in this site, you don't need to take further action.

Upgrade a Custom installation

In Custom (distributed) installations, the API Gateway has been optional until XProtect VMS 2023 R3.

  • If the API Gateway isn't currently selected, you might want to select it now. The API Gateway is mandatory in Milestone XProtect VMS 2024 R2 and later.

  • If this is the only instance of the API Gateway in this site, you don't need to take further action.

Upgrade instances of the API Gateway using the API Gateway installer

When you have upgraded the management server using the XProtect VMS Products installer, you can use the management server's download web page to download and install system component on other hosts.

For more information, see Install the API Gateway using the API Gateway installer.