Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

The node provides integration with the Homebridge API, specifically supporting backup and restore operations. The "Restore Scheduled Backup" operation allows users to restore a previously scheduled backup on their Homebridge server. This is useful for scenarios where you want to revert your Homebridge setup to a known good state after changes or failures.

Practical examples include:

  • Automatically restoring a backup after a failed plugin update.
  • Reverting configuration changes by restoring a scheduled backup.
  • Integrating backup restoration into automated maintenance workflows.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation or entered manually for authentication.
Backup ID The unique identifier of the scheduled backup to restore. Required to specify which backup to restore.

Output

The node outputs JSON data representing the result of the restore operation. This typically includes confirmation details such as status messages or metadata about the restored backup. There is no indication that binary data is output by this node.

Dependencies

  • Requires an active connection to the Homebridge API.
  • Needs an API authentication token (access token) either from a previous login node or manual entry.
  • The base URL for the Homebridge server must be configured in the node credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Invalid or missing Access Token: The node requires a valid access token for authentication. If not provided or expired, the API call will fail. Ensure the token is current or use a Login node to refresh it.
  • Backup ID not found: Providing an incorrect or non-existent backup ID will cause the restore operation to fail. Verify the backup ID before running the node.
  • Connection issues: Network problems or incorrect server URL configurations can prevent communication with the Homebridge API. Check connectivity and credential settings.
  • API errors: Any error responses from the Homebridge API will be surfaced by the node. Review error messages for guidance on resolution.

Links and References

Discussion