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 via the Site Manager API. Specifically, for the Host resource with the Get Many operation, this node retrieves multiple host records from the UniFi network. This is useful for scenarios where you want to list all connected hosts or a subset of them for monitoring, reporting, or further automation tasks.

Practical examples include:

  • Fetching all hosts currently connected to a UniFi site to monitor network usage.
  • Retrieving a limited number of hosts for quick status checks or troubleshooting.
  • Integrating host data into dashboards or other systems for network management.

Properties

Name Meaning
Return All Whether to return all host results or only up to a specified limit.
Limit The maximum number of host results to return when "Return All" is set to false (minimum 1).

Output

The node outputs JSON data containing an array of host objects retrieved from the UniFi Site Manager API. Each host object typically includes details such as host identifiers, IP addresses, MAC addresses, connection status, and other relevant metadata about the host device on the network.

If binary data were involved (e.g., images or files), it would be summarized here, but in this case, the output is purely JSON-based host information.

Dependencies

  • Requires an API authentication token credential to access the UniFi Site Manager API.
  • The node communicates with the UniFi Site Manager API endpoint at https://api.ui.com.
  • Proper network permissions and API access rights are necessary to retrieve host data.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or expired API tokens.
    • Network connectivity issues preventing access to the UniFi API endpoint.
    • Request limits exceeded if too many hosts are requested without proper pagination.

  • Error Messages:

    • Unauthorized or 401 errors: Check that the API key credential is correctly configured and valid.
    • Timeouts or connection errors: Verify network connectivity and API availability.
    • Invalid parameter errors: Ensure that the "Limit" property is set to a positive integer when "Return All" is false.

Links and References

Discussion