UniFi API OpenAPI Specifications

This repository contains OpenAPI 3.1.0 specifications for UniFi Network and Protect APIs, automatically extracted from UniFi controllers.

Available Versions

UniFi Network API

14 version(s) available:

• 10.2.78
• 10.1.85
• 10.1.84
• 10.1.83
• 10.1.80
• 10.1.78
• 10.1.68
• 10.0.162
• 9.5.21
• 9.4.19
• 9.3.45
• 9.2.87
• 9.1.120
• 9.0.99

UniFi Protect API

13 version(s) available:

• 7.0.70
• 7.0.66
• 7.0.64
• 7.0.59
• 6.2.88
• 6.2.87
• 6.2.83
• 6.2.79
• 6.2.77
• 6.2.72
• 6.1.79
• 6.0.53
• 5.3.48

Directory Structure

unifi-network/
  ├── 10.2.78.json
  └── ...
unifi-protect/
  ├── 7.0.70.json
  └── ...

Usage

These OpenAPI specifications can be used to:

• Generate API clients in various languages
• Generate API documentation
• Validate API requests and responses
• Understand API capabilities and changes between versions

Generating Python Clients

# Install openapi-python-client
pip install openapi-python-client

# Generate Network API client
openapi-python-client generate --path unifi-network/10.2.78.json --output-path unifi-network-client

# Generate Protect API client
openapi-python-client generate --path unifi-protect/7.0.70.json --output-path unifi-protect-client

Notes

• These specifications are automatically extracted from UniFi controllers
• Specifications are in OpenAPI 3.1.0 format
• Each version is stored as a separate file for easy comparison and version management
• Updates are published automatically when new versions are detected