← All articles

Update the REST API to a new version

Each version of the REST API matches the Sage 50 Canadian Edition release it supports. To move to a new version, run the new installer on the server where the REST API is installed and choose to update the existing installation. Setup upgrades it in place: the URL, the IIS app pool and the API key stay the same, so your apps and AI clients keep working without any configuration change.

Before you update

Start the installer

Windows may block the installer the first time you run it. If the Windows protected your PC screen appears, click More info.

Microsoft Defender SmartScreen window titled Windows protected your PC, with the pointer on the More info link.
Click More info to show the app details.

Check that the app name is the installer we sent you, then click Run anyway.

SmartScreen window showing App ArivSageApi-2027.0-26.10.1.exe, with the Run anyway and Don't run buttons.
The app name matches the installer file. Click Run anyway.

Choose the language for setup, English or French, and click OK.

Select Setup Language dialog with a language drop-down list and the OK and Cancel buttons.
Pick the setup language.

Read the license agreement, select I accept the agreement, and click Next.

License Agreement page of the installer showing the terms and conditions, with the accept option selected.
Accept the license agreement to continue.

Setup then shows the Prerequisites page while it checks the Windows features IIS needs: World Wide Web Services, IIS Management Scripts and Tools, HTTP Activation and ASP.NET 4.8. On a server where the REST API is already installed, these features are already on. Wait for the page to finish. If Windows asks for a restart, restart the server and run setup again.

Choose the installation to update

Setup asks whether to update an existing installation or create a new one. Select Update an existing installation and click Next.

Installation type page with Update an existing installation selected and Create a new installation not selected.
Update an existing installation keeps its URL and API key.

The list shows every REST API installation on the server, by IIS website and virtual path. Setup preselects the last one installed. Below the list, check its URL, physical path and app pool, then click Next.

Installation to update page with Default Web Site / Sage50RestApi selected, showing the URL http://localhost/Sage50RestApi/, the physical path and the app pool Ariv.Sage50.Api.
Check the URL, physical path and app pool of the installation you are updating.

Check the application settings

A notice confirms that setup found an existing installation at this IIS location and will update it. Check the Sage company file (.SAI), the Sage user name and the password the API uses to open the company file. If the company file has moved, click Browse to select it. Click Next.

Application settings page with a notice that an existing installation was detected, and fields for the Sage SAI file, the Sage user name and the Sage password.
Point to the company file and the Sage user the API signs in with.

Choose the MCP server

Leave Install the MCP server as an IIS child application under the REST API selected to keep or add the MCP server at ai/mcp. Clear it to update the REST API alone. If the MCP server is already installed, clearing this option removes it. See Connect AI clients to Sage 50.

Sage MCP access page with the option to install the MCP server as an IIS child application under the REST API at ai/mcp selected.
The MCP server is installed as a child application at ai/mcp.

Confirm client access

This version installs HTTP endpoints. Select the acknowledgement that API keys and Sage 50 data are sent in clear text over HTTP, and that you are responsible for configuring HTTPS in IIS, firewall rules and certificates where needed. Click Next.

Client access page explaining that this version installs HTTP endpoints, with the acknowledgement checkbox selected.
Acknowledge that the endpoints use HTTP.

Run the update

Setup lists what it will do: update the application files, the REST API IIS application and, if selected, the MCP IIS application. Check the website, path and URLs, then click Update.

Ready to Update page listing the actions: update the application files in C:\Program Files\Ariv\Sage50RestApi, the REST API IIS application at http://localhost/Sage50RestApi/ and the MCP IIS application at http://localhost/Sage50RestApi/ai/mcp.
Review the actions, then click Update.

When the update is complete, setup shows the REST API URL, the MCP URL and the API key. They are the same as before the update, so nothing changes in your apps or AI clients. Click Finish.

Update complete screen showing the REST API URL, the MCP URL and a blurred API key field with a Copy button.
The REST API URL, MCP URL and API key stay the same after an update.

To update the REST API for another company file, run the setup again and select that installation.

Check the installed version

Call GET /api/database with your API key. The Ariv-Product-Version response header returns the installed product version, for example 26.10.1.

curl -i http://localhost/Sage50RestApi/api/database \
  -H "x-api-key: YOUR_API_KEY"
HTTP/1.1 200 OK
Ariv-Product-Version: 26.10.1

Add or Remove Programs also shows the Sage 50 version and the product version, for example 2027.0-26.10.1.

Next steps