Actions80
- 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
Plugin → Get Config Schema
AI-generatedOverview
This node interacts with the Homebridge API to retrieve the configuration schema of a specified plugin. It is useful for users who want to programmatically access the configuration details of Homebridge plugins, for example, to automate plugin setup or validation processes.
Use Case Examples
- A user wants to fetch the configuration schema of a Homebridge plugin named 'example-plugin' to dynamically generate a configuration UI.
- An automation workflow retrieves plugin config schemas to validate user inputs before applying settings.
Properties
| Name | Meaning |
|---|---|
| Access Token | Access token from Login operation. If not connected to Login node, enter manually. |
| Plugin Name | The name of the plugin whose configuration schema is to be retrieved. |
| Request Options | Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout settings. |
Output
JSON
configSchema- The configuration schema of the specified plugin returned from the Homebridge API.
Dependencies
- Homebridge API access with an API key or access token
Troubleshooting
- Ensure the access token is valid and has not expired; otherwise, authentication errors may occur.
- Verify the plugin name is correct and exists in the Homebridge environment to avoid 'plugin not found' errors.
- Check network connectivity and proxy settings if requests time out or fail.
- If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request will be rejected.
Links
- Homebridge API Documentation - Official documentation for Homebridge API endpoints and usage.