UniFi Site Manager icon

UniFi Site Manager

Manage UniFi devices and networks through the Site Manager API
Join our community

Actions5

Overview

The "UniFi Site Manager" node allows users to manage UniFi devices and networks through the Site Manager API. Specifically, for the Site resource with the Get Many operation, this node retrieves multiple site records from the UniFi system. This is useful for scenarios where you need to list all sites managed by your UniFi controller or fetch a subset of sites based on a limit.

Practical examples include:

  • Fetching all sites to display in a dashboard.
  • Retrieving a limited number of sites for reporting or monitoring purposes.
  • Integrating site data into other workflows or systems for automation.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit. Options: true or false.
Limit Max number of results to return when "Return All" is set to false. Minimum value is 1.

Output

The output contains a JSON field with an array of site objects retrieved from the UniFi Site Manager API. Each object represents a site with its associated properties as defined by the API (e.g., site ID, name, configuration details). The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the UniFi Site Manager API.
  • The node uses the base URL https://api.ui.com for API requests.
  • Proper network access to the UniFi Site Manager API endpoint is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • No results returned: Verify that sites exist in the UniFi controller and that any limits set are appropriate.
  • API connectivity issues: Check network connectivity and firewall settings to allow access to https://api.ui.com.
  • Invalid limit values: The "Limit" property must be at least 1; otherwise, the node may throw an error or return no data.

Links and References

Discussion