UniFi Site Manager icon

UniFi Site Manager

Manage UniFi devices and networks through the Site Manager API

Actions5

Overview

The node "UniFi Site Manager" allows users to manage UniFi devices and networks through the Site Manager API. Specifically, for the Host - Get operation, it retrieves detailed information about a specific host device by its unique identifier. This is useful in scenarios where network administrators need to query the status, configuration, or metadata of a particular host within their UniFi-managed network.

Practical examples include:

  • Fetching details of a host device to monitor its connectivity or performance.
  • Retrieving host information before performing further automated network management tasks.
  • Integrating host data into dashboards or reports for network analysis.

Properties

Name Meaning
Host ID The unique identifier of the host to retrieve. Example format: 507f1f77bcf86cd799439011

Output

The output JSON contains the detailed information of the requested host. This typically includes all relevant properties returned by the UniFi Site Manager API for that host, such as its network status, configuration, identifiers, and other metadata.

If the node supports binary data output (not indicated here), it would represent any associated files or media related to the host, but this operation primarily returns JSON data describing the host.

Dependencies

  • Requires an API key credential for authenticating with the UniFi Site Manager API.
  • The node communicates with the UniFi Site Manager API endpoint at https://api.ui.com.
  • Proper network access and permissions to query the UniFi Site Manager API are necessary.

Troubleshooting

  • Missing or invalid Host ID: Ensure the Host ID is provided and correctly formatted; otherwise, the API will not return the host data.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Confirm that the n8n instance can reach https://api.ui.com.
  • API rate limits or downtime: If requests fail repeatedly, check for API rate limiting or service outages.

Common error messages might include unauthorized access, resource not found (if the Host ID does not exist), or network timeouts.

Links and References

  • UniFi Site Manager API Documentation (official API docs for more details on host data structure and endpoints)
  • UniFi community forums and support channels for troubleshooting API access and usage

Discussion