Homebridge icon

Homebridge

Interact with Homebridge API

Actions80

Server → Get Unused Port

AI-generated

Overview

This node interacts with the Homebridge API to retrieve an unused port on the Homebridge server. It is useful for scenarios where you need to dynamically find an available port for setting up new services or plugins within the Homebridge environment, ensuring no port conflicts occur.

Use Case Examples

  1. A user wants to add a new accessory or plugin to Homebridge and needs to assign it a port that is not currently in use.
  2. Automating the setup of Homebridge plugins that require network ports, by programmatically fetching an unused port before configuration.

Properties

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

Output

JSON

  • port - The unused port number retrieved from the Homebridge server.

Dependencies

  • Homebridge API access with an API key credential (access token)

Troubleshooting

  • Ensure the access token is valid and has not expired; otherwise, authentication errors may occur.
  • If SSL certificate validation fails and the option to ignore SSL issues 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.

Links

Discussion