Ubiquiti

UISP Network (NMS) API

The UISP Network (NMS) API is the per-instance REST API for the network-management half of UISP — Ubiquiti's purpose-built ISP platform for wireless and fiber service providers. Endpoints are served from each UISP instance under `/nms/api/v2.1/` (e.g. `/nms/api/v2.1/devices`, `/nms/api/v2.1/devices/{id}/detail`, sites, outages, alerts, statistics). Authentication uses an `x-auth-token` header carrying an API token generated in the UISP console; tokens can be issued in read-only or read/write mode. A live Swagger UI is hosted at `https://{your-host}/nms/api-docs/` on every UISP installation.

GitHub

Documentation

📖
Documentation
https://help.uisp.com/hc/en-us/sections/22589678457879-UISP-Network
📖
Documentation
https://help.uisp.com/hc/en-us/articles/22590956856087-UISP-CRM-API-Usage

API entry from apis.yml

apis.yml Raw ↑ 
aid: ubiquiti:uisp-nms-api
name: UISP Network (NMS) API
tags:
- ISP
- UISP
- WISP
- Network Management
humanURL: https://uisp.ui.com/nms/api-docs/
properties:
- url: https://help.uisp.com/hc/en-us/sections/22589678457879-UISP-Network
  type: Documentation
- url: https://help.uisp.com/hc/en-us/articles/22590956856087-UISP-CRM-API-Usage
  type: Documentation
description: The UISP Network (NMS) API is the per-instance REST API for the network-management half of
  UISP — Ubiquiti's purpose-built ISP platform for wireless and fiber service providers. Endpoints are
  served from each UISP instance under `/nms/api/v2.1/` (e.g. `/nms/api/v2.1/devices`, `/nms/api/v2.1/devices/{id}/detail`,
  sites, outages, alerts, statistics). Authentication uses an `x-auth-token` header carrying an API token
  generated in the UISP console; tokens can be issued in read-only or read/write mode. A live Swagger
  UI is hosted at `https://{your-host}/nms/api-docs/` on every UISP installation.