Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

This node integrates with the Homebridge API, specifically allowing users to manage and retrieve configuration details related to Homebridge plugins. The "Get Plugin Config" operation under the "Config Editor" resource fetches the configuration settings of a specified plugin within Homebridge. This is useful for scenarios where you want to programmatically inspect or audit plugin configurations, automate configuration backups, or integrate Homebridge plugin settings into broader automation workflows.

For example, a user might use this node to:

  • Retrieve the current configuration of a Homebridge plugin before updating it.
  • Verify plugin settings as part of a monitoring or compliance check.
  • Extract plugin configuration data to feed into a dashboard or reporting tool.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation. If not using a connected login node, enter the token manually here. This token authenticates the request to the Homebridge API.
Plugin Name The exact name of the Homebridge plugin whose configuration you want to retrieve. This is a required field.

Output

The node outputs JSON data representing the configuration of the specified Homebridge plugin. This JSON structure contains all relevant configuration parameters and their current values as stored in Homebridge. The output can be used directly in subsequent workflow steps for processing, logging, or conditional logic.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Homebridge server API endpoint.
  • Needs an API authentication token (access token) to authorize requests.
  • The node expects the Homebridge server URL and credentials to be configured properly in n8n.
  • The user must provide the plugin name to specify which plugin's config to retrieve.

Troubleshooting

  • Invalid or missing access token: If the access token is incorrect or expired, the node will fail to authenticate. Ensure the token is valid and refreshed if necessary.
  • Plugin not found: If the specified plugin name does not exist on the Homebridge server, the node may return an error or empty configuration. Double-check the plugin name spelling and availability.
  • Connection issues: Network problems or incorrect server URL configuration can cause request failures. Verify connectivity and server URL correctness.
  • Permission errors: Insufficient permissions associated with the access token can prevent fetching plugin configs. Confirm that the token has adequate rights.

Links and References

Discussion