Connect Ubiquiti UISP

UISP is Ubiquiti's platform for wireless ISPs and fibre operators. It is two products behind one address: NMS, which manages the network hardware (airMAX, airFiber, airCube, UFiber OLTs and ONUs, EdgeRouter), and CRM, a full ISP billing system covering subscribers, services, invoices, payments and field-job scheduling. StackJack connects to both through your own UISP server.

UISP is not UniFi

These are different Ubiquiti products with separate StackJack connectors, and the distinction matters before you start:

• UISP is the wireless-ISP and fibre line. Its subscribers are paying internet customers, and it includes billing. Its tools are named uisp_.
• UniFi is the enterprise networking line — switches, access points, cameras. Its tools are named unifi_.

They share no equipment, no account and no credentials. A key from one will not work with the other, and nothing you do in this connector affects the other.

What your AI can do

Connecting UISP gives your AI a set of uisp_ MCP tools — MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

On the network side

• Find your equipment — every managed device with its status, model, firmware, uptime and site, plus a MAC address index for identifying hardware from a support ticket
• Investigate a fault — device statistics, system logs, outage history, interface state, DHCP leases, and the wireless clients associated with an access point
• Work with fibre — list OLTs and the ONUs on each, read optical signal levels, and see what is connected inside a subscriber's premises
• Read configuration — system settings, services, interfaces, static routes, OSPF, DHCP scopes and airCube wireless settings
• Act on hardware — reboot a device, adopt one that is waiting, flash its locate LED, take and restore configuration backups, block or upgrade an ONU
• Manage sites and staff — create and update sites, and review the operator accounts that can sign in to UISP

On the billing side

• Answer account questions — a subscriber's record, balance, services, invoices, payments and the notes staff have left on their account
• Manage subscriptions — create a service, change a plan, suspend or restore a customer, apply speed overrides, and handle change requests
• Run billing — draft, preview, approve, send and void invoices; issue credit notes; record payments and refunds; manage recurring payment plans and stored cards
• Look after the catalogue — service plans, plan groups, one-off products, taxes and surcharges
• Schedule field work — installs and repairs, with their task lists, comments and attachments

Read tools are available on the Free tier. Tools that change something require the Pro tier.

Before you start

You need the address you sign in to UISP with, and at least one key. There are two, one per side, and you do not need both — a network-only operator can supply just the NMS token, and a billing-only operator just the CRM app key. Anything you leave out simply means those tools report that the side is not set up.

Your UISP server must have a certificate from a public certificate authority. StackJack will not connect to a self-signed or internal-CA certificate, because ignoring certificate errors would leave your keys open to interception on the way to your server. UISP can obtain a valid certificate for you.

Create the network API token

Skip this if you only want the billing tools.

1. Sign in to UISP and open the NMS application.
2. Click the gear icon in the left toolbar for Settings.
3. Go to Users and open the API Tokens tab.
4. Create a token.
5. Copy it immediately — UISP shows it once and cannot show it again.

Create the billing app key

Skip this if you have no CRM licence.

1. Switch to the CRM application.
2. Open System → Security and select the App Keys tab.
3. Create an app key and choose its permission level.
4. Copy it immediately — as with the token, UISP shows it once.

Choose the right permission level

An app key is created as Read, Write or Full, and that level cannot be changed afterwards. This catches people out, because a Read key looks fine: it passes the connection test, since the test only proves the key is genuine, not that it is powerful enough. Every billing tool that changes something then comes back refused.

If you want the Pro-tier billing tools to work, choose Full. If billing writes start returning permission errors later, the usual cause is a Read-level key, and the fix is to create a new one at a higher level.

Add it to StackJack

1. In StackJack, open Connectors and choose Ubiquiti UISP.
2. Enter your UISP address exactly as you use it — your own server (for example https://uisp.example.com) or the Ubiquiti-hosted one (for example https://yourname.uisp.com).
3. Paste whichever key or keys you created.
4. Save, then run Test Connection.

The test checks only the sides you supplied a key for, so a network-only or billing-only setup passes normally.

Editing your credentials later

Both key fields start blank when you reopen the form, and leaving one blank keeps the key already stored. That is deliberate: UISP shows each key once, so if you had to re-type both every time you touched the form, adding the second key later would mean producing a value you can no longer obtain.

Because a blank field means "keep", removing a key needs its own deliberate step. A remove checkbox appears under each key once one is stored. Tick it only if you have revoked that key in UISP or are moving to the other side alone — saving deletes it, UISP cannot show it to you again, and the tools for that side stop working. StackJack will not let you remove both at once, since that would leave the connector with no way in.

Things worth knowing

Network lists return everything. Unlike the billing side, the network device and ONU lists are not paged — they return the whole collection at once. On a large network that can be a very large response, so narrow them by site or by parent device.

Some tools have real-world consequences. Rebooting a tower radio takes out every customer behind it, not one subscriber. Restoring a saved configuration replaces whatever the device is running now. Suspending or ending a service cuts a paying customer's internet, usually within minutes. Creating or refunding a payment moves real money, and sending an invoice or receipt cannot be recalled. All of these require the Pro tier and are marked destructive. Whether your AI application asks you to confirm before running one depends on that application's own settings — see Destructive tools and confirmation. Review those settings, and grant only the actions you want an AI to take.

Billing suspensions rely on a link. A subscription is tied to a network site, and that link is what lets a suspension on the billing side actually cut the connection. If that link is removed, the customer keeps their internet regardless of their account status, and nothing else reports it.

Troubleshooting

"Not configured" on some tools but not others. You supplied one key, not both. Network tools need the NMS token; billing tools need the CRM app key. Add the missing one, or use the other side's tools.

The connection test passes but billing writes are refused. Your CRM app key was created at Read level. The level is fixed at creation, so create a new key at Full and replace the stored one.

Everything returns an authorization error. The key for that side is wrong or was revoked. Check you have not pasted the CRM key into the NMS field or the reverse — they are not interchangeable and there is no error that says so. Create a fresh key on the correct side and re-test.

StackJack cannot reach your server. Check the address is the same one you sign in with, including https://. If your UISP server uses a self-signed or internal certificate, replace it with one from a public certificate authority.

A network tool says the device was not found. Device and ONU identifiers are long and not human-readable, and the billing side uses entirely separate numeric identifiers. Look the device up in the relevant list first rather than reusing an identifier from the other side.

Several customers

Some MSPs need one Ubiquiti UISP connection per customer, console or region. StackJack can hold several named connections of one connector, and your AI names the one it wants on each call. See Several connections of one connector.

Full tool list

See the generated Ubiquiti UISP tool reference for the current inventory, plan assignment, input schemas, and destructive-action labels.

Ubiquiti UISP tools

uisp_ · 258 tools · Free 118 · Pro 140

Network: Devices

Network: Device Configuration

Network: Device Backups

Network: Fibre (OLT & ONU)

Network: Sites

Network: Health, Logs & Outages

Network: Tasks

Network: Operator Users

Billing: Subscribers

Billing: Subscriber Contacts & Bank Accounts

Billing: Services & Suspension

Billing: Service Plans & Products

Billing: Invoices

Billing: Quotes & Credit Notes

Billing: Payments & Refunds

Billing: Field Jobs & Scheduling

Billing: Organizations

Billing: Taxes, Surcharges & Documents