Actions77
- Accessory Actions
- Authentication Actions
- Backup & Restore Actions
- Config Editor Actions
- Platform Tool Actions
- Plugin Actions
- Server Actions
- Restart Server
- Restart Child Bridge
- Stop Child Bridge
- Start Child Bridge
- Get Pairing Info
- Reset Homebridge Accessory
- Reset Cached Accessories
- Get Cached Accessories
- Delete Cached Accessories
- Delete Cached Accessory
- Get Device Pairings
- Get Device Pairing
- Delete Device Pairing
- Get Unused Port
- Get Network Interfaces
- Get Bridge Network Interfaces
- Set Bridge Network Interfaces
- Setup Wizard Actions
- Status Actions
- User Actions
Overview
The node provides integration with the Homebridge API, allowing users to interact with various aspects of a Homebridge server. Specifically, for the "Config Editor" resource and the "Get Config" operation, the node retrieves the current configuration of the Homebridge instance. This is useful for scenarios where you want to programmatically access or audit the Homebridge configuration, automate backups, or integrate configuration data into other workflows.
Practical examples include:
- Fetching the Homebridge config to verify settings before applying changes.
- Automating configuration backups by retrieving and storing the config regularly.
- Integrating Homebridge config data into monitoring dashboards or alerting systems.
Properties
| Name | Meaning |
|---|---|
| Access Token | Access token obtained from a prior login operation or entered manually if not connected to a Login node. Used to authenticate requests to the Homebridge API. |
Output
The node outputs JSON data representing the Homebridge configuration retrieved from the server. The structure corresponds to the full configuration object as returned by the Homebridge API's config endpoint.
If the node supports binary data output (not indicated here), it would typically represent files or backups related to the configuration, but this is not evident in the provided code.
Dependencies
- Requires an active connection to a Homebridge server with API access enabled.
- Needs an API authentication token ("Access Token") to authorize requests.
- The node expects credentials including the Homebridge server URL and the access token.
- No additional external services are required beyond the Homebridge API.
Troubleshooting
Common issues:
- Invalid or missing access token will cause authentication failures.
- Incorrect server URL or network issues can prevent connecting to the Homebridge API.
- Insufficient permissions on the token may restrict access to configuration data.
Error messages:
- Authentication errors typically indicate invalid or expired tokens; re-authenticate or provide a valid token.
- Network errors suggest checking server availability and connectivity.
- API errors may require verifying that the Homebridge server supports the requested operation and that the user has appropriate rights.