Homebridge icon

Homebridge

Interact with Homebridge API

Actions80

Backup & Restore → Create Backup

AI-generated

Overview

This node interacts with the Homebridge API to create a backup of the Homebridge system. It is useful for users who want to safeguard their Homebridge configuration and data by generating backups that can be restored later if needed. Typical use cases include scheduled backups, manual backup triggers before system updates, or migration of Homebridge setups to new hardware.

Use Case Examples

  1. A user schedules this node to run daily to create automatic backups of their Homebridge configuration.
  2. Before upgrading Homebridge or installing new plugins, a user runs this node to create a backup to ensure they can restore the previous state if something goes wrong.

Properties

Name Meaning
Access Token Access token from Login operation. If not connected to Login node, enter manually.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • backupId - Identifier of the created backup.
  • status - Status of the backup creation operation.
  • message - Additional information or message returned from the backup creation process.

Dependencies

  • Homebridge API access with an access token or API key credential

Troubleshooting

  • Ensure the access token is valid and has not expired; otherwise, authentication errors will occur.
  • If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request may be blocked.
  • Proxy settings must be correctly configured if used; incorrect proxy details can cause connection failures.
  • Timeout settings should be adjusted based on network conditions to avoid premature request abortion.

Discussion