Integration endpoints
Every external system NetLock RMM talks to: what it is for, and where to configure it in the Console.
Integration endpoints
This appendix lists every external system the product talks to, what the integration is for, and where in the Console it is configured. Use it as a firewall-review checklist and as a quick index when you need to find "where do I plug in the X credentials?".
Every row points to the chapter where the integration is documented in depth. The configuration column names the Console page that owns the credentials.
X.5.1 Community and catalogues
Three upstream services feed Collections with content you can pick from or publish into.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
| GitHub | Source for Community Scripts. The Scripts library pulls community-published scripts from a GitHub-backed catalogue and can publish local scripts back. | Chapter 8.1 — Scripts. |
| Winget | Windows package catalogue exposed inside App Hub. A deployment-level Refresh catalogs action syncs the latest catalogue into the Console. | Chapter 8.5 — App Hub. |
| Flathub | Linux package catalogue exposed inside App Hub. Refreshed together with Winget and Chocolatey. | Chapter 8.5 — App Hub. |
| Chocolatey | Secondary Windows package catalogue exposed inside App Hub. | Chapter 8.5 — App Hub. |
App Hub catalogues are refreshed on the server, not in the operator's browser. The server therefore needs outbound access to the relevant catalogue; the operator's workstation does not.
X.5.2 Notification channels
Five channels on the Notifications page reach outbound destinations. Every channel is independently configurable and every recipient carries a severity filter and a tenant scope.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
| SMTP (any provider) | Email notifications. Global SMTP configuration plus per-recipient addresses. | A.8.2 — Email (SMTP). |
Microsoft Teams webhook (Workflows) | Post alerts to a Teams channel through a Power Automate flow. One connector per channel. | A.8.3 — Microsoft Teams. |
| Telegram Bot API | Send alerts to a Telegram chat or group via a bot token. | A.8 — Notifications deep dive. |
| ntfy.sh (or self-hosted ntfy) | Push notifications to phones and desktops via topic URL. | A.8 — Notifications deep dive. |
| Generic webhook (notifications) | Arbitrary HTTPS POST per event. Use it to feed a SIEM, a ChatOps pipeline, or any service that accepts JSON. | A.8 — Notifications deep dive. |
Each channel has its own Test action that sends a probe. Run the test on every channel right after setup.
X.5.3 Ticket System webhooks
Separate from the notification webhooks above, the Ticket System has its own outbound webhooks per department.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
| Generic webhook (tickets) | Per-department HTTPS POST fired on ticket lifecycle events (created, replied, resolved, closed). One webhook per department, with per-event toggles. | Chapter 10.16. |
Ticket webhooks follow the same URL + secret + events shape as the notifications webhook but draw from a different event stream. They also require the tickets_manage_webhooks flag.
X.5.4 Identity providers
One SSO provider can be active at a time. All of them use OpenID Connect; SAML 2.0 is not supported. The same configuration page has a tab for each.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
| Azure AD (Microsoft Entra ID) | OIDC sign-in for Azure-federated organisations. | A.4.2 — Single Sign-On. |
| Keycloak | OIDC sign-in backed by a self-hosted Keycloak realm. | A.4.2 — Single Sign-On. |
| Google (Workspace / Identity) | OIDC sign-in for Google-federated organisations. | A.4.2 — Single Sign-On. |
| Okta | OIDC sign-in for Okta tenants. | A.4.2 — Single Sign-On. |
| Auth0 | OIDC sign-in for Auth0 tenants. | A.4.2 — Single Sign-On. |
Saving SSO configuration restarts the Web Console; plan the change for a maintenance window.
X.5.5 AI / LLM
Where AI requests go depends on the model source selected on the AI / LLM Settings page. The two paths below are mutually exclusive: a deployment uses one or the other. See A.11.2 — Model selection.
Managed NetLock AI
Selected with Use NetLock AI (managed), and the default for a new deployment.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
Members Portal API (https://api.members.netlockrmm.com) | The only host the deployment itself contacts in this mode. The Web Console posts chat completions to it; the server does the same for the end-user tray chat. Authentication is the deployment's Members Portal API key. | A.11.2 — Model selection. |
| IONOS AI Hub | NetLock's upstream inference provider. The Members Portal API forwards the request to it and streams the answer back. The deployment never connects to it directly, so it is not a firewall entry. It is, however, where prompt content is processed, which is relevant for a data-protection review. | A.11.2 — Model selection. |
Your own provider
Selected with Use my own model. The configuration speaks the OpenAI chat-completions shape, so any provider that exposes that shape works. Requests go directly from the Web Console (and, for the end-user tray chat, from the server) to the host you enter; nothing passes through the Members Portal.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
| OpenAI | Hosted GPT models via https://api.openai.com/v1. | A.11.3 — Provider configuration. |
| Anthropic (OpenAI-compatible endpoint) | Claude models via the OpenAI-compatible endpoint at https://api.anthropic.com/v1. | A.11.3. |
| Ollama | Local model runtime, usually reached on http://localhost:11434/v1. | A.11.3. |
| LM Studio | Local model runtime, usually reached on http://localhost:1234/v1. | A.11.3. |
| Any OpenAI-compatible provider | LocalAI, vLLM, self-hosted OpenAI-compatible gateways. Enter the provider's API Base URL and Model manually; API Key stays empty when the provider needs no authentication. | A.11.3. |
localhost in the local-model templates resolves to the host running the Console, not to the operator's workstation and not to a device running the agent. Adjust the base URL when the model runs on a different machine. The base URL is used exactly as entered with /chat/completions appended, so it has to carry the /v1 segment where the provider uses one.
X.5.6 Members Portal
The infrastructure endpoint behind community features and licence information.
| Endpoint / Service | Purpose | Configuration home |
|---|---|---|
Members Portal API (https://api.members.netlockrmm.com) | Deployment-level authentication and distribution for community features (Community Scripts, Community Reports, Community Themes) and for licence information. The same host carries the managed AI path described in X.5.5. A single API key is stored on the deployment; every operator inherits it. | Chapter 15 — Community. |
X.5.6a Integration connections
Connections of the integrations store talk to the product they connect, in two ways:
| Direction | From | To | Purpose |
|---|---|---|---|
| Outbound | Web console | The address of the vendor | The test of the assistant and the lists of its dropdowns, such as companies and queues. |
| Outbound | Server | The address of the vendor | Tickets, notes, device sync, contract quantities, status pulls of security and backup products. |
| Local | Server | 127.0.0.1:7480 on the server itself | Connectors read NetLock data through the public API. Integrations:Loopback_Port changes the port, 0 switches it off. Do not publish this port or open it in a firewall. |
Both the web console and the server therefore need the outbound path to a connected product. The addresses depend on the product:
- IT Glue, GravityZone and Acronis accept only vendor addresses: the three API hosts of IT Glue, hosts below
gravityzone.bitdefender.comand hosts belowacronis.com. - Lexware Office, sevdesk and Docusnap365 have a fixed address:
api.lexware.io,my.sevdesk.deandapi.docusnap365.com. - Autotask has no address field in the setup: NetLock asks
webservices.autotask.netfor the zone of the API user and then talks to thewebservices<n>.autotask.nethost of that zone. - NetBox, Snipe-IT and Wazuh run at the customer: any address can be entered, and a cloud instance reaches them only on a public address. Wazuh needs two addresses, the server API (port 55000) and the indexer (port 9200), both with a valid certificate.
Vendors cannot reach anything inside NetLock through a connection: all of its traffic starts on the NetLock side.
A self-hosted instance can reach public and private addresses, but never loopback, link-local or cloud metadata addresses. A cloud instance reaches only public addresses. The same rules apply to public API webhooks. When a system proxy is set for a self-hosted instance, connections use it, and the name of the target has to be resolvable from the instance as well, because the address rules are checked before the request.
X.5.7 Outbound firewall checklist
For a self-hosted deployment, the server needs outbound HTTPS to every endpoint above that the deployment actually uses. A starter checklist:
api.members.netlockrmm.com: for any community feature, for licence information, and for the managed NetLock AI.- The catalogue hosts for Winget, Flathub, and Chocolatey: only for App Hub refreshes.
- The identity provider's OIDC discovery and token endpoints: only for SSO.
- Each notification destination: SMTP gateway, the host in the Teams webhook URL, Telegram API, ntfy.sh (or your self-hosted ntfy), and whatever your generic webhooks target.
- The address of each connected product in the integrations store, from the server and from the web console.
- The LLM provider's base URL: only when AI features are enabled and the deployment uses its own model. With the managed NetLock AI there is no separate AI destination; that traffic goes to
api.members.netlockrmm.com.
Cloud deployments delegate this connectivity to the hosted operations team; only the notifications and LLM endpoints remain the customer's firewall concern.
Agent-side egress
The list above covers the server. Every managed device additionally needs outbound access to the deployment's own backend address: the host and port the installer was built with (443 in a standard deployment). That single address carries all five agent roles (communication, remote, update, trust, file server) plus the SignalR command, screen and tunnel hubs, so one rule is enough. The agents open no UDP side channel and use no STUN / TURN.
Where the devices have no direct egress, that traffic can go through a forward proxy. Point the agents at it with the installer's proxy parameters, described in Devices behind an HTTP proxy. Two things matter when the firewall rules are written:
- Only the backend traffic uses the proxy. LAN sensor probes, network and SNMP discovery, Wake-on-LAN and the jump-host end of a tunnel keep connecting directly and must keep their direct path to the local network.
- The proxy has to allow the
CONNECTmethod to the backend host on443for the WebSocket transport of the hubs. If the proxy refuses it, the connection falls back to server-sent events and then to long polling, and remote control and screen sharing are noticeably slower.
Related chapters
- Chapter 8 — Collections — Scripts, App Hub, and the upstream catalogues.
- Chapter 10 — Tickets — department webhooks.
- Chapter 15 — Community — Members Portal API key.
- A.4 — Security: IP whitelist, rate limiting & SSO.
- A.8 — Notifications deep dive.
- A.11 — AI / LLM configuration.