BridgeService
A list of all methods in the BridgeService
service. Click on the method name to view detailed information about that method.
Methods | Description |
---|---|
get_bridges | List all available bridges |
get_bridge | Get details of a single bridge from its given {bridgeId} . |
update_bridge | Update a single bridge from its given {bridgeId} . |
get_bridges
List all available bridges
- HTTP Method:
GET
- Endpoint:
/clip/v2/resource/bridge
Return Type
GetBridgesOkResponse
Example Usage Code Snippet
from open_hue import OpenHue, Environment
sdk = OpenHue(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER",
base_url=Environment.DEFAULT.value
)
result = sdk.bridge.get_bridges()
print(result)
get_bridge
Get details of a single bridge from its given {bridgeId}
.
- HTTP Method:
GET
- Endpoint:
/clip/v2/resource/bridge/{bridgeId}
Parameters
Name | Type | Required | Description |
---|---|---|---|
bridge_id | str | ✅ | ID of the bridge |
Return Type
GetBridgeOkResponse
Example Usage Code Snippet
from open_hue import OpenHue, Environment
sdk = OpenHue(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER",
base_url=Environment.DEFAULT.value
)
result = sdk.bridge.get_bridge(bridge_id="bridgeId")
print(result)
update_bridge
Update a single bridge from its given {bridgeId}
.
- HTTP Method:
PUT
- Endpoint:
/clip/v2/resource/bridge/{bridgeId}
Parameters
Name | Type | Required | Description |
---|---|---|---|
request_body | BridgePut | ❌ | The request body. |
bridge_id | str | ✅ | ID of the bridge |
Return Type
UpdateBridgeOkResponse
Example Usage Code Snippet
from open_hue import OpenHue, Environment
from open_hue.models import BridgePut
sdk = OpenHue(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER",
base_url=Environment.DEFAULT.value
)
request_body = BridgePut(
type_="bridge"
)
result = sdk.bridge.update_bridge(
request_body=request_body,
bridge_id="bridgeId"
)
print(result)
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs