Skip to content

API Quick Search

Browse all UniFi Access API endpoints by category. Select any operation from the sidebar to view its details, parameters, and response schemas.

Configure Your Environment (Optional)

Enter your UniFi Access host and API key below so that code examples are ready to copy & paste.

Values are saved in your browser and will replace {host} and Bearer ... in all code examples across this site.

Privacy Notice

This is an optional convenience feature for testing purposes only. All values are stored exclusively in your browser's localStorage — no data is transmitted to any server. If you have concerns, you can fork this project on GitHub and run it locally, or simply copy the example code and replace the placeholders yourself.

Getting Started

  1. Create an API Token — Go to your UniFi Console → Access → Settings → General → Advanced → API Token
  2. Optionally enter your host and API key above so code examples are ready to use
  3. Browse endpoints from the sidebar or use the search bar

TIP

The API host is typically https://<your-console-ip>:12445. All requests require HTTPS.