Replace the Members Portal API key

Self-hosted only: This guide applies to self-hosted deployments. On cloud, the hosted operations team manages licensing — there is no API key for you to change.

The Members Portal API key is the credential the server and Web Console use to fetch your licence. It is a deployment credential and is not editable in the Console — the Licensing page shows it read-only (see A.1). Replacing it means editing each service's appsettings.json, clearing the cached licence and package data, and restarting the containers.

You replace the key on both services — the Web Console and the server. The paths below assume the standard deployment layout under /home/netlock.

Before you start

• Shell access to the host running the NetLock RMM containers.
• The new API key from the Members Portal.
• A short maintenance window is sensible: both services restart, and the server rebuilds its agent packages on first use afterwards.

Step 1 — Update the configuration files

Open each service's appsettings.json and set the new key in the ApiKeyOverride field, inside the Members_Portal_Api section:

sudo nano /home/netlock/web_console/appsettings.json
sudo nano /home/netlock/server/appsettings.json

In both files, replace the value of ApiKeyOverride with the new API key. Save and close each file.

Step 2 — Clear the cached licence and package data

Each service caches the licence it last loaded, and the server caches the agent installer packages it built under that licence. Delete these so they are regenerated against the new key:

sudo rm /home/netlock/web_console/internal/license_info.json
sudo rm /home/netlock/server/internal/license_info.json
sudo rm -r /home/netlock/server/internal/packages

Step 3 — Restart the containers

Restart both services so they read the updated configuration:

sudo docker restart netlock-rmm-web-console
sudo docker restart netlock-rmm-server

On startup, each service uses the new API key to fetch fresh licence information from the Members Portal, and the server rebuilds the agent packages it cleared.

Verify it worked

• Open Settings → Licensing in the Console. The licence status, name, and seat count reflect the new licence — see A.1. If the status looks wrong, use Refresh License Information on that page.

Code signing changes trigger an agent reinstall

If the new licence changes the code-signing entitlement — moving from a licence without code signing to one with it, or the reverse — the agents reinstall themselves automatically to match. The server rebuilds its agent packages under the new entitlement, which is why internal/packages is cleared in Step 2, and managed devices pick up the rebuilt agent on their next sync. No manual reinstall is needed.

Related

• A.1 — System overview & licensing — the Licensing page and what it reports.
• Upgrade NetLock RMM — pulling new container images.