Welcome to unificontrol’s documentation!

unificontrol is a rich and full-featured Python interface to the Ubiquiti Unifi software defined network controller. Goals of this package include:

• A clean interface that supports introspection and self-documentation.
• A complete implementation of the Unifi controller API. Currently it supports over 100 API calls to the Unifi controller.
• Proper handling of SSL connections to allow secure access to the controller even when the controller uses a self-signed certificate.
• A concise, readable internal representation of the Unifi API, so that new API calls can easily be added as new features are added to the controller.
• Python 3 only, since it’s the way of the future.

This is a reference to login() to check what works.

Contents:

• Introduction
  • Installation
  • Documentation
  • Usage
  • Support for self-signed certificates
  • Acknowledgments
• API details
  • Data types
  • The UnifiClient class
  • Constants
• SSL Security with self-signed certificates
• Adding to the API
  • Metaprogramming
  • Implementing API calls
  • JSON fix-up methods

Indices and tables

• Index
• Search Page