Overview
This node interacts with the UniFi Site Manager API, specifically allowing users to retrieve information about a Host by its unique identifier. It is useful in scenarios where network administrators or automation workflows need to fetch details about a specific host device managed within a UniFi network environment. For example, you might use this node to get the status, IP address, or other metadata of a particular host device for monitoring or reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Host ID | The unique identifier of the host to retrieve. This is a required string input specifying which host's details to fetch from the UniFi Site Manager API. |
Output
The node outputs JSON data representing the details 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, IP address, MAC address, hostname, and any other metadata associated with the host entity.
If the API supports binary data related to hosts (e.g., logs or configuration files), the node would handle it accordingly, but based on the provided code and context, the output is primarily JSON structured data.
Dependencies
- Requires an API key credential for authenticating requests to the UniFi Site Manager API.
- The node depends on the external UniFi Site Manager API endpoint at
https://api.ui.com/ea. - Proper configuration of the API key credential within n8n is necessary for successful operation.
Troubleshooting
- Invalid API Key: If the API key is incorrect or expired, the node will return an authentication error. Ensure the API key is valid and has the necessary permissions.
- Host Not Found: Providing an incorrect or non-existent Host ID will result in no data or an error response. Verify the Host ID before execution.
- Network Issues: Connectivity problems to the UniFi API endpoint can cause timeouts or failures. Check network access and firewall settings.
- Permission Issues: The API key must have sufficient rights to read host information; otherwise, access may be denied.
Links and References
- UniFi Site Manager API Documentation (official API base URL, refer to vendor docs for detailed endpoints)
- UniFi Network Management (general product information)