Skip to content

UniFi import (API) (UNIFIAPI)

Generated page

This page mirrors server/plugins/unifi_api_import/README.md and is regenerated on every docs build.

Overview

UniFi import plugin using the newer, API-key-based Site Manager API - the successor to the username/password controller login used by the older unifi_import plugin. Prefer this one where available; fall back to unifi_import if your controller doesn't expose the Site Manager integration API yet.

Tip

The Site Manager API doesn't seems to have feature parity with the old API yet, so certain limitations apply.

Quick setup guide

Navigate to your UniFi Site Manager Settings -> Control Plane -> Integrations.

  • UNIFIAPI_api_key : You can generate your API key under the Your API Keys section.
  • UNIFIAPI_base_url : You can find your base url in the API Request Format section, e.g. https://192.168.100.1/proxy/network/integration/
  • UNIFIAPI_api_version : You can find your version as part of the url in the API Request Format section, e.g. v1
  • UNIFIAPI_verify_ssl : To skip SSL with you don't have an SSL certificate

Usage

  • Head to Settings > UniFi import (API) to adjust the default values.

Notes

  • Version: 1.0.0
  • Author: jokob-sk
  • Release Date: Aug 2025