# OpenHue We're on a mission to make integrating Philips Hue smart lighting easier than ever. Our open-source projects simplify your development process, whether you're building a smart home app, automation scripts, or anything in between.
## Our Projects ### [**openhue-api**](https://github.com/openhue/openhue-api) The heart of OpenHue Project, an OpenAPI specification for the Philips Hue REST API. Connect and control Hue devices effortlessly. More info in the [API](/api/openhue-api) section. ### [**openhue-cli**](https://github.com/openhue/openhue-cli) Automation made easy. OpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems. More info in the [CLI](/cli/openhue-cli) section. # OpenHue API OpenHue API is an open-source project that provides a comprehensive OpenAPI specification for the Philips Hue REST API. The OpenHue API is published on [Redocly](https://cuddly-fireant-79.redoc.ly/). You can use [this link](https://api.redocly.com/registry/bundle/openhue/openhue/v2/openapi.yaml?branch=main) to access the OpenAPI specification or click [here](https://api.redocly.com/registry/bundle/openhue/openhue/v2/openapi.yaml?branch=main\&download) to directly download it. # Authentication The authentication API allows to retrieve the hue-application-key, that is passed as header for Authorization. {% openapi src="" path="/api" method="post" expanded="true" %} {% endopenapi %} You absolutely need to press the button on your Hue bridge before calling this endpoint. Otherwise, the response will contain the message `"link button not pressed"`. This is a security step so that only apps you want to control your lights can. By pressing the button, you prove that you have physical access to the bridge. # Resource This endpoint allows retrieving all resources exposed by the Hue Bridge. {% openapi src="" path="/clip/v2/resource" method="get" expanded="true" %} {% endopenapi %} # Bridge API to manage the bridge. {% openapi src="" path="/clip/v2/resource/bridge" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/bridge/{bridgeId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/bridge/{bridgeId}" method="put" expanded="true" %} {% endopenapi %} # Home Homes group rooms as well as devices not assigned to a room. {% openapi src="" path="/clip/v2/resource/bridge\_home" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/bridge\_home/{bridgeHomeId}" method="get" expanded="true" %} {% endopenapi %} # Device API to manage devices. Devices have device level properties and offer services such as light. {% openapi src="" path="/clip/v2/device" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/device/{deviceId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/device/{deviceId}" method="put" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/device/{deviceId}" method="delete" expanded="true" %} {% endopenapi %} {% hint style="info" %} Please note that the bridge device cannot be deleted {% endhint %} ## Device Power These are offered by battery powered devices. {% openapi src="" path="/clip/v2/device\_power" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/device\_power/{deviceId}" method="get" expanded="true" %} {% endopenapi %} # Light These are offered by devices with lighting capabilities. {% openapi src="" path="/clip/v2/resource/light" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/light/{lightId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/light/{lightId}" method="put" expanded="true" %} {% endopenapi %} ## Grouped Light These are offered by rooms, zones, and homes. {% openapi src="" path="/clip/v2/resource/grouped\_light" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/grouped\_light/{groupedLightId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/grouped\_light/{groupedLightId}" method="put" expanded="true" %} {% endopenapi %} # Scene Scenes are used to store and recall settings for a group of lights. {% openapi src="" path="/clip/v2/resource/scene" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/scene" method="post" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/scene/{sceneId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/scene/{sceneId}" method="put" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/scene/{sceneId}" method="delete" expanded="true" %} {% endopenapi %} # Room Rooms group devices and each device can only be part of one room. {% openapi src="" path="/clip/v2/resource/room" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/room" method="post" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/room/{roomId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/room/{roomId}" method="put" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/room/{roomId}" method="delete" expanded="true" %} {% endopenapi %} # Zone Zones group services and each service can be part of multiple zones. {% openapi src="" path="/clip/v2/resource/zone" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/zone" method="post" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/zone/{zoneId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/zone/{zoneId}" method="put" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/zone/{zoneId}" method="delete" expanded="true" %} {% endopenapi %} # Sensors This page regroups the sensors-related APIs. ## Light Level These are offered by devices with light level sensing capabilities. {% openapi src="" path="/clip/v2/resource/light\_level" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/light\_level/{lightId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/light\_level/{lightId}" method="put" expanded="true" %} {% endopenapi %} ## Temperature These are offered by devices with temperature sensing capabilities. {% openapi src="" path="/clip/v2/resource/temperature" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/temperature/{temperatureId}" method="get" expanded="true" %} {% endopenapi %} {% openapi src="" path="/clip/v2/resource/temperature/{temperatureId}" method="put" expanded="true" %} {% endopenapi %} # OpenHue API OpenHue API is an open-source project that provides a comprehensive OpenAPI specification for the Philips Hue REST API. The OpenHue API is published on [Redocly](https://cuddly-fireant-79.redoc.ly/). You can use [this link](https://api.redocly.com/registry/bundle/openhue/openhue/v2/openapi.yaml?branch=main) to access the OpenAPI specification or click [here](https://api.redocly.com/registry/bundle/openhue/openhue/v2/openapi.yaml?branch=main\&download) to directly download it. # Auth Authentication operations. ## Authenticate > Authenticate to retrieve the HUE application key. Requires to go and press the button on the bridge ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Auth","description":"Authentication operations."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"paths":{"/api":{"post":{"operationId":"authenticate","summary":"Authenticate","description":"Authenticate to retrieve the HUE application key. Requires to go and press the button on the bridge","tags":["Auth"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"devicetype":{"type":"string"},"generateclientkey":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Authentication Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}},"components":{"schemas":{"response":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"object","properties":{"success":{"type":"object","properties":{"username":{"type":"string"},"clientkey":{"type":"string"}}},"error":{"type":"object","properties":{"type":{"type":"integer"},"address":{"type":"string"},"description":{"type":"string"}}}}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}} ``` # Resource API to retrieve all API resources ## List resources > API to retrieve all API resources ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Resource","description":"API to retrieve all API resources"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceGet":{"type":"object","description":"The API is actually returning the full resource description depending on the type, not just the fields that are\ndocumented below.\n","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource":{"get":{"operationId":"getResources","summary":"List resources","description":"API to retrieve all API resources","tags":["Resource"],"responses":{"200":{"description":"Resource Success Response","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceGet"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Device API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted. ## List devices > List all available devices ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DeviceGet":{"type":"object","description":"Definition of a device resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["product_data","metadata","identify","services"],"properties":{"type":{"type":"string","enum":["device"]},"product_data":{"$ref":"#/components/schemas/ProductData"},"metadata":{"type":"object","required":["name","archetype"],"properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","description":"Triggers a visual identification sequence on the device"},"usertest":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode.\nIn usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)\n"}}},"services":{"type":"array","description":"References all services providing control and state of the device.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device":{"get":{"operationId":"getDevices","summary":"List devices","description":"List all available devices","tags":["Device"],"responses":{"200":{"description":"Device Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get device > Get details of a single device from its given \`{deviceId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DeviceGet":{"type":"object","description":"Definition of a device resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["product_data","metadata","identify","services"],"properties":{"type":{"type":"string","enum":["device"]},"product_data":{"$ref":"#/components/schemas/ProductData"},"metadata":{"type":"object","required":["name","archetype"],"properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","description":"Triggers a visual identification sequence on the device"},"usertest":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode.\nIn usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)\n"}}},"services":{"type":"array","description":"References all services providing control and state of the device.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device/{deviceId}":{"get":{"operationId":"getDevice","summary":"Get device","description":"Get details of a single device from its given `{deviceId}`.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device"}],"responses":{"200":{"description":"Device Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update device > Update a single device from its given \`{deviceId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"DevicePut":{"type":"object","properties":{"type":{"type":"string","enum":["device"]},"metadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","properties":{"action":{"type":"string","description":"Triggers a visual identification sequence, current implemented as (which can change in the future):\nBridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors\nperform LED identification cycles for 15 seconds\n","enum":["identify"]}}},"usertest":{"type":"object","properties":{"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate\nstate changes on device LED (if applicable)\n"}}}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device/{deviceId}":{"put":{"operationId":"updateDevice","summary":"Update device","description":"Update a single device from its given `{deviceId}`.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevicePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Delete Device > Delete a single Device from its given \`{deviceId}\`. The \`bridge\` device cannot be deleted. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device/{deviceId}":{"delete":{"operationId":"deleteDevice","summary":"Delete Device","description":"Delete a single Device from its given `{deviceId}`. The `bridge` device cannot be deleted.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the Device"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Device Power API to manage device power services. These are offered by battery powered devices. The update endpoint (e.g. `PUT`) was intentionally not implemented. ## List device powers > List all available device powers ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device Power","description":"API to manage device power services. These are offered by battery powered devices. The update endpoint (e.g. `PUT`) was intentionally not implemented."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DevicePowerGet":{"type":"object","description":"Definition of a device power resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["power_state"],"properties":{"power_state":{"type":"object","properties":{"battery_state":{"type":"string","enum":["normal","low","critical"],"description":"Status of the power source of a device, only for battery powered devices.\n\n- `normal` – battery level is sufficient\n- `low` – battery level low, some features (e.g. software update) might stop working, please change battery soon\n- `critical` – battery level critical, device can fail any moment\n"},"battery_level":{"type":"integer","minimum":0,"maximum":100,"description":"The current battery state in percent, only for battery powered devices."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device_power":{"get":{"operationId":"getDevicePowers","summary":"List device powers","description":"List all available device powers","tags":["Device Power"],"responses":{"200":{"description":"Device Power Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DevicePowerGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get device power > Get power details of a single device from its given \`{deviceId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device Power","description":"API to manage device power services. These are offered by battery powered devices. The update endpoint (e.g. `PUT`) was intentionally not implemented."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DevicePowerGet":{"type":"object","description":"Definition of a device power resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["power_state"],"properties":{"power_state":{"type":"object","properties":{"battery_state":{"type":"string","enum":["normal","low","critical"],"description":"Status of the power source of a device, only for battery powered devices.\n\n- `normal` – battery level is sufficient\n- `low` – battery level low, some features (e.g. software update) might stop working, please change battery soon\n- `critical` – battery level critical, device can fail any moment\n"},"battery_level":{"type":"integer","minimum":0,"maximum":100,"description":"The current battery state in percent, only for battery powered devices."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device_power/{deviceId}":{"get":{"operationId":"getDevicePower","summary":"Get device power","description":"Get power details of a single device from its given `{deviceId}`.","tags":["Device Power"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device"}],"responses":{"200":{"description":"Device Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DevicePowerGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Light API to manage light services. These are offered by devices with lighting capabilities. ## List lights. > List all available lights. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Light","description":"API to manage light services. These are offered by devices with lighting capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"LightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["metadata","identify","service_id","on","mode"],"properties":{"metadata":{"type":"object","description":"Deprecated, use metadata on device level","required":["name","archetype","function"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/LightArchetype"},"function":{"type":"string","description":"Function of the light service","enum":["functional","decorative","mixed","unknown"]},"fixed_mired":{"type":"integer","minimum":153,"maximum":500,"description":"A fixed mired value of the white lamp"}}},"identify":{"type":"object","description":"Triggers identification sequence on the light"},"service_id":{"type":"integer","minimum":0,"description":"Service identification number. 0 indicates service of a single instance"},"on":{"$ref":"#/components/schemas/On"},"dimming":{"type":"object","properties":{"brightness":{"$ref":"#/components/schemas/Brightness"},"min_dim_level":{"type":"number","minimum":0,"maximum":100,"description":"Percentage of the maximum lumen the device outputs on minimum brightness"}}},"color_temperature":{"type":"object","properties":{"mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"mirek_valid":{"type":"boolean","description":"Indication whether the value presented in mirek is valid"},"mirek_schema":{"type":"object","properties":{"mirek_minimum":{"type":"integer","minimum":153,"maximum":500,"description":"minimum color temperature this light supports"},"mirek_maximum":{"type":"integer","minimum":153,"maximum":500,"description":"maximum color temperature this light supports"}}}}},"color":{"type":"object","properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"},"gamut":{"type":"object","description":"Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.","properties":{"red":{"$ref":"#/components/schemas/GamutPosition"},"green":{"$ref":"#/components/schemas/GamutPosition"},"blue":{"$ref":"#/components/schemas/GamutPosition"}}},"gamut_type":{"type":"string","description":"The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut","enum":["A","B","C","other"]}}},"dynamics":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SupportedDynamicStatus"},"status_values":{"type":"array","description":"Statuses in which a lamp could be when playing dynamics.","items":{"$ref":"#/components/schemas/SupportedDynamicStatus"}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid"},"speed_valid":{"type":"boolean","description":"Indicates whether the value presented in speed is valid"}}},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","description":"Supported alert actions for this light.","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing signaling properties.","properties":{"signal_values":{"type":"array","items":{"$ref":"#/components/schemas/SupportedSignals"}},"estimated_end":{"type":"integer","description":"Timestamp indicating when the active signal is expected to end. Value is not set if there is no_signal"},"colors":{"type":"array","description":"Colors that were provided for the active effect.","items":{"$ref":"#/components/schemas/Color"}}}},"mode":{"type":"string","enum":["normal","streaming"]},"gradient":{"type":"object","allOf":[{"$ref":"#/components/schemas/Gradient"},{"type":"object","properties":{"points_capable":{"type":"integer","description":"Number of color points that gradient lamp is capable of showing with gradience."},"mode_values":{"type":"array","description":"Modes a gradient device can deploy the gradient palette of colors","items":{"$ref":"#/components/schemas/SupportedGradientMode"}},"pixel_count":{"type":"integer","description":"Number of pixels in the device"}}}]},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"status":{"$ref":"#/components/schemas/SupportedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"effect":{"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}}}},"effects_v2":{"$ref":"#/components/schemas/EffectsV2"},"timed_effects":{"type":"object","description":"Basic feature containing timed effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedTimedEffects"},"effect_values":{"type":"array","description":"Possible timed effect values you can set in a light","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"status":{"$ref":"#/components/schemas/SupportedTimedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing a timed effect.","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"duration":{"type":"integer","description":"Duration is mandatory when timed effect is set except for no_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms."}}},"powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}},"product_data":{"type":"object","description":"Product data about the light.","properties":{"function":{"type":"string","description":"Function of the light source.","enum":["functional","decorative","mixed","unknown"]}}},"geometry":{"type":"object","description":"Geometry information for pixel-addressable lights such as gradient strips.","properties":{"pixel_positions":{"type":"array","description":"Ordered list of pixel positions for this light. Empty for non-gradient lights.","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"LightArchetype":{"type":"string","description":"Light archetype","enum":["unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"SupportedDynamicStatus":{"type":"string","description":"Current status of the lamp with dynamics.","enum":["dynamic_palette","none"]},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light":{"get":{"operationId":"getLights","summary":"List lights.","description":"List all available lights.","tags":["Light"],"responses":{"200":{"description":"Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get light > Get details of a single light from its given \`{lightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Light","description":"API to manage light services. These are offered by devices with lighting capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"LightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["metadata","identify","service_id","on","mode"],"properties":{"metadata":{"type":"object","description":"Deprecated, use metadata on device level","required":["name","archetype","function"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/LightArchetype"},"function":{"type":"string","description":"Function of the light service","enum":["functional","decorative","mixed","unknown"]},"fixed_mired":{"type":"integer","minimum":153,"maximum":500,"description":"A fixed mired value of the white lamp"}}},"identify":{"type":"object","description":"Triggers identification sequence on the light"},"service_id":{"type":"integer","minimum":0,"description":"Service identification number. 0 indicates service of a single instance"},"on":{"$ref":"#/components/schemas/On"},"dimming":{"type":"object","properties":{"brightness":{"$ref":"#/components/schemas/Brightness"},"min_dim_level":{"type":"number","minimum":0,"maximum":100,"description":"Percentage of the maximum lumen the device outputs on minimum brightness"}}},"color_temperature":{"type":"object","properties":{"mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"mirek_valid":{"type":"boolean","description":"Indication whether the value presented in mirek is valid"},"mirek_schema":{"type":"object","properties":{"mirek_minimum":{"type":"integer","minimum":153,"maximum":500,"description":"minimum color temperature this light supports"},"mirek_maximum":{"type":"integer","minimum":153,"maximum":500,"description":"maximum color temperature this light supports"}}}}},"color":{"type":"object","properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"},"gamut":{"type":"object","description":"Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.","properties":{"red":{"$ref":"#/components/schemas/GamutPosition"},"green":{"$ref":"#/components/schemas/GamutPosition"},"blue":{"$ref":"#/components/schemas/GamutPosition"}}},"gamut_type":{"type":"string","description":"The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut","enum":["A","B","C","other"]}}},"dynamics":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SupportedDynamicStatus"},"status_values":{"type":"array","description":"Statuses in which a lamp could be when playing dynamics.","items":{"$ref":"#/components/schemas/SupportedDynamicStatus"}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid"},"speed_valid":{"type":"boolean","description":"Indicates whether the value presented in speed is valid"}}},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","description":"Supported alert actions for this light.","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing signaling properties.","properties":{"signal_values":{"type":"array","items":{"$ref":"#/components/schemas/SupportedSignals"}},"estimated_end":{"type":"integer","description":"Timestamp indicating when the active signal is expected to end. Value is not set if there is no_signal"},"colors":{"type":"array","description":"Colors that were provided for the active effect.","items":{"$ref":"#/components/schemas/Color"}}}},"mode":{"type":"string","enum":["normal","streaming"]},"gradient":{"type":"object","allOf":[{"$ref":"#/components/schemas/Gradient"},{"type":"object","properties":{"points_capable":{"type":"integer","description":"Number of color points that gradient lamp is capable of showing with gradience."},"mode_values":{"type":"array","description":"Modes a gradient device can deploy the gradient palette of colors","items":{"$ref":"#/components/schemas/SupportedGradientMode"}},"pixel_count":{"type":"integer","description":"Number of pixels in the device"}}}]},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"status":{"$ref":"#/components/schemas/SupportedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"effect":{"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}}}},"effects_v2":{"$ref":"#/components/schemas/EffectsV2"},"timed_effects":{"type":"object","description":"Basic feature containing timed effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedTimedEffects"},"effect_values":{"type":"array","description":"Possible timed effect values you can set in a light","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"status":{"$ref":"#/components/schemas/SupportedTimedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing a timed effect.","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"duration":{"type":"integer","description":"Duration is mandatory when timed effect is set except for no_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms."}}},"powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}},"product_data":{"type":"object","description":"Product data about the light.","properties":{"function":{"type":"string","description":"Function of the light source.","enum":["functional","decorative","mixed","unknown"]}}},"geometry":{"type":"object","description":"Geometry information for pixel-addressable lights such as gradient strips.","properties":{"pixel_positions":{"type":"array","description":"Ordered list of pixel positions for this light. Empty for non-gradient lights.","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"LightArchetype":{"type":"string","description":"Light archetype","enum":["unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"SupportedDynamicStatus":{"type":"string","description":"Current status of the lamp with dynamics.","enum":["dynamic_palette","none"]},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light/{lightId}":{"get":{"operationId":"getLight","summary":"Get light","description":"Get details of a single light from its given `{lightId}`.","tags":["Light"],"parameters":[{"name":"lightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"responses":{"200":{"description":"Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update light > Update a single light from its given \`{lightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Light","description":"API to manage light services. These are offered by devices with lighting capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"LightPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `light` here)"},"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"dimming_delta":{"$ref":"#/components/schemas/DimmingDelta"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"color_temperature_delta":{"$ref":"#/components/schemas/ColorTemperatureDelta"},"color":{"$ref":"#/components/schemas/Color"},"dynamics":{"$ref":"#/components/schemas/LightDynamics"},"alert":{"$ref":"#/components/schemas/Alert"},"signaling":{"$ref":"#/components/schemas/Signaling"},"mode":{"type":"string","enum":["normal","streaming"]},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"$ref":"#/components/schemas/Effects"},"effects_v2":{"$ref":"#/components/schemas/EffectsV2"},"timed_effects":{"type":"object","description":"Basic feature containing timed effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedTimedEffects"},"duration":{"type":"integer","description":"Duration is mandatory when timed effect is set except for no_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms."}}},"powerup":{"$ref":"#/components/schemas/Powerup"}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"LightDynamics":{"type":"object","properties":{"duration":{"type":"integer","description":"Duration of a light transition or timed effects in ms."},"speed":{"type":"number","minimum":0,"maximum":0,"description":"Speed of dynamic palette or effect.\nThe speed is valid for the dynamic palette if the status is `dynamic_palette` or for the corresponding effect listed in status.\nIn case of status `none`, the speed is not valid.\n"}}},"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}},"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"Effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]},"Powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Brightness"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light/{lightId}":{"put":{"operationId":"updateLight","summary":"Update light","description":"Update a single light from its given `{lightId}`.","tags":["Light"],"parameters":[{"name":"lightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LightPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Light Level API to manage light level services. These are offered by devices with light level sensing capabilities. ## List light levels. > List all available light levels. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"LightLevel","description":"API to manage light level services. These are offered by devices with light level sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"LightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","light"],"properties":{"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"},"light":{"type":"object","required":["light_level","light_level_valid"],"properties":{"light_level":{"type":"integer","description":"Deprecated. Moved to light_level_report/light_level"},"light_level_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in light_level is valid"},"light_level_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"light_level":{"type":"integer","description":"Light level in 10000*log10(lux) +1 measured by sensor.\nLogarithmic scale used because the human eye adjusts to light levels and small changes at low\nlux levels are more noticeable than at high lux levels.\nThis allows use of linear scale configuration sliders.\n"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light_level":{"get":{"operationId":"getLightLevels","summary":"List light levels.","description":"List all available light levels.","tags":["LightLevel"],"responses":{"200":{"description":"Light Level Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LightLevelGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get light > Get details of a single light from its given \`{lightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"LightLevel","description":"API to manage light level services. These are offered by devices with light level sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"LightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","light"],"properties":{"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"},"light":{"type":"object","required":["light_level","light_level_valid"],"properties":{"light_level":{"type":"integer","description":"Deprecated. Moved to light_level_report/light_level"},"light_level_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in light_level is valid"},"light_level_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"light_level":{"type":"integer","description":"Light level in 10000*log10(lux) +1 measured by sensor.\nLogarithmic scale used because the human eye adjusts to light levels and small changes at low\nlux levels are more noticeable than at high lux levels.\nThis allows use of linear scale configuration sliders.\n"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light_level/{lightId}":{"get":{"operationId":"getLightLevel","summary":"Get light","description":"Get details of a single light from its given `{lightId}`.","tags":["LightLevel"],"parameters":[{"name":"lightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"responses":{"200":{"description":"Light Level Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LightLevelGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update light > Update a single light from its given \`{lightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"LightLevel","description":"API to manage light level services. These are offered by devices with light level sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"LightLevelPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `light_level` here)"},"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/light_level/{lightId}":{"put":{"operationId":"updateLightLevel","summary":"Update light","description":"Update a single light from its given `{lightId}`.","tags":["LightLevel"],"parameters":[{"name":"lightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LightLevelPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Motion API to manage motion services. These are offered by devices with motion sensing capabilities. ## List motion sensors. > List all available motion sensors. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Motion","description":"API to manage motion services. These are offered by devices with motion sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","motion"],"properties":{"enabled":{"type":"boolean","description":"true when the sensor is activated, false when deactivated"},"motion":{"type":"object","required":["motion","motion_valid"],"properties":{"motion":{"type":"boolean","description":"Deprecated. Moved to motion_report/motion."},"motion_valid":{"type":"boolean","description":"Deprecated. Motion is valid when motion_report property is present, invalid when absent."},"motion_report":{"type":"object","properties":{"changed":{"type":"string","description":"last time the value of this property is changed"},"motion":{"type":"boolean","description":"true if motion is detected"}}}}},"sensitivity":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"sensitivity":{"type":"integer","description":"Sensitivity of the sensor. Value in the range 0 to sensitivity_max"},"sensitivity_max":{"type":"integer","description":"Maximum value of the sensitivity configuration attribute."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion":{"get":{"operationId":"getMotionSensors","summary":"List motion sensors.","description":"List all available motion sensors.","tags":["Motion"],"responses":{"200":{"description":"Motion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get motion sensor. > Get details of a single motion sensor from its given \`{motionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Motion","description":"API to manage motion services. These are offered by devices with motion sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","motion"],"properties":{"enabled":{"type":"boolean","description":"true when the sensor is activated, false when deactivated"},"motion":{"type":"object","required":["motion","motion_valid"],"properties":{"motion":{"type":"boolean","description":"Deprecated. Moved to motion_report/motion."},"motion_valid":{"type":"boolean","description":"Deprecated. Motion is valid when motion_report property is present, invalid when absent."},"motion_report":{"type":"object","properties":{"changed":{"type":"string","description":"last time the value of this property is changed"},"motion":{"type":"boolean","description":"true if motion is detected"}}}}},"sensitivity":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"sensitivity":{"type":"integer","description":"Sensitivity of the sensor. Value in the range 0 to sensitivity_max"},"sensitivity_max":{"type":"integer","description":"Maximum value of the sensitivity configuration attribute."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion/{motionId}":{"get":{"operationId":"getMotionSensor","summary":"Get motion sensor.","description":"Get details of a single motion sensor from its given `{motionId}`.","tags":["Motion"],"parameters":[{"name":"motionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the motion sensor"}],"responses":{"200":{"description":"Motion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update Motion Sensor > Update a single motion sensor from its given \`{motionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Motion","description":"API to manage motion services. These are offered by devices with motion sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"MotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion` here)"},"enabled":{"type":"boolean","description":"true when the sensor is activated, false when deactivated"},"sensitivity":{"type":"object","properties":{"sensitivity":{"type":"integer","description":"Sensitivity of the sensor. Value in the range 0 to sensitivity_max."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion/{motionId}":{"put":{"operationId":"updateMotionSensor","summary":"Update Motion Sensor","description":"Update a single motion sensor from its given `{motionId}`.","tags":["Motion"],"parameters":[{"name":"motionId","in":"path","schema":{"type":"string"},"required":true,"description":"Id of the motion sensor"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MotionPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Grouped Light API to manage grouped light services. These are offered by rooms, zones, and homes. ## List grouped lights > List all grouped lights ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"on":{"description":"Joined on control & aggregated on state. “on” is true if any light in the group is on.","$ref":"#/components/schemas/On"},"dimming":{"description":"Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.","$ref":"#/components/schemas/Dimming"},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal_values":{"type":"array","description":"Signals that the light supports.","items":{"$ref":"#/components/schemas/SupportedSignals"}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light":{"get":{"operationId":"getGroupedLights","summary":"List grouped lights","description":"List all grouped lights","tags":["GroupedLight"],"responses":{"200":{"description":"Grouped Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get grouped light > Get details of a single grouped light from its given \`{groupedLightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"on":{"description":"Joined on control & aggregated on state. “on” is true if any light in the group is on.","$ref":"#/components/schemas/On"},"dimming":{"description":"Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.","$ref":"#/components/schemas/Dimming"},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal_values":{"type":"array","description":"Signals that the light supports.","items":{"$ref":"#/components/schemas/SupportedSignals"}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light/{groupedLightId}":{"get":{"operationId":"getGroupedLight","summary":"Get grouped light","description":"Get details of a single grouped light from its given `{groupedLightId}`.","tags":["GroupedLight"],"parameters":[{"name":"groupedLightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped light"}],"responses":{"200":{"description":"Grouped Light Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update grouped light > Update a single grouped light from its given \`{groupedLightId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLight","description":"API to manage grouped light services. These are offered by rooms, zones, and homes."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GroupedLightPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_light` here)","enum":["grouped_light"]},"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"dimming_delta":{"$ref":"#/components/schemas/DimmingDelta"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"color_temperature_delta":{"$ref":"#/components/schemas/ColorTemperatureDelta"},"color":{"$ref":"#/components/schemas/Color"},"alert":{"$ref":"#/components/schemas/Alert"},"signaling":{"$ref":"#/components/schemas/Signaling"},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}},"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light/{groupedLightId}":{"put":{"operationId":"updateGroupedLight","summary":"Update grouped light","description":"Update a single grouped light from its given `{groupedLightId}`.","tags":["GroupedLight"],"parameters":[{"name":"groupedLightId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the light"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedLightPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Bridge API to manage the bridge ## List bridges > List all available bridges ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Bridge","description":"API to manage the bridge"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BridgeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["bridge_id","time_zone"],"properties":{"type":{"type":"string","enum":["bridge"]},"bridge_id":{"type":"string","description":"Unique identifier of the bridge as printed on the device. Lower case."},"time_zone":{"type":"object","required":["time_zone"],"properties":{"time_zone":{"type":"string","description":"Time zone where the user's home is located (as Olson ID)."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bridge":{"get":{"operationId":"getBridges","summary":"List bridges","description":"List all available bridges","tags":["Bridge"],"responses":{"200":{"description":"Bridge Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BridgeGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get bridge > Get details of a single bridge from its given \`{bridgeId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Bridge","description":"API to manage the bridge"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BridgeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["bridge_id","time_zone"],"properties":{"type":{"type":"string","enum":["bridge"]},"bridge_id":{"type":"string","description":"Unique identifier of the bridge as printed on the device. Lower case."},"time_zone":{"type":"object","required":["time_zone"],"properties":{"time_zone":{"type":"string","description":"Time zone where the user's home is located (as Olson ID)."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bridge/{bridgeId}":{"get":{"operationId":"getBridge","summary":"Get bridge","description":"Get details of a single bridge from its given `{bridgeId}`.","tags":["Bridge"],"parameters":[{"name":"bridgeId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the bridge"}],"responses":{"200":{"description":"Bridge Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BridgeGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update bridge > Update a single bridge from its given \`{bridgeId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Bridge","description":"API to manage the bridge"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"BridgePut":{"type":"object","properties":{"type":{"type":"string","enum":["bridge"]}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bridge/{bridgeId}":{"put":{"operationId":"updateBridge","summary":"Update bridge","description":"Update a single bridge from its given `{bridgeId}`.","tags":["Bridge"],"parameters":[{"name":"bridgeId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the bridge"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BridgePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Bridge Home API to manage bridge homes. Homes group rooms as well as devices not assigned to a room. ## List bridge homes. > List all available bridge homes. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Bridge Home","description":"API to manage bridge homes. Homes group rooms as well as devices not assigned to a room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BridgeHomeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services"],"properties":{"type":{"type":"string","enum":["bridge_home"]},"children":{"type":"array","description":"Child devices/services to group by the derived group.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition\nof grouped type Supported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bridge_home":{"get":{"operationId":"getBridgeHomes","summary":"List bridge homes.","description":"List all available bridge homes.","tags":["Bridge Home"],"responses":{"200":{"description":"Bridge Home Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BridgeHomeGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get bridge home. > Get details of a single bridge home from its given \`{bridgeHomeId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Bridge Home","description":"API to manage bridge homes. Homes group rooms as well as devices not assigned to a room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BridgeHomeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services"],"properties":{"type":{"type":"string","enum":["bridge_home"]},"children":{"type":"array","description":"Child devices/services to group by the derived group.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition\nof grouped type Supported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bridge_home/{bridgeHomeId}":{"get":{"operationId":"getBridgeHome","summary":"Get bridge home.","description":"Get details of a single bridge home from its given `{bridgeHomeId}`.","tags":["Bridge Home"],"parameters":[{"name":"bridgeHomeId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the bridge home."}],"responses":{"200":{"description":"Bridge Home Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BridgeHomeGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Scene API to manage scenes. Scenes are used to store and recall settings for a group of lights. ## List scenes > List all available scenes ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["actions","metadata","group","speed","auto_dynamic","status"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionGet"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"},"status":{"type":"object","properties":{"active":{"type":"string","enum":["inactive","static","dynamic_palette"]}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene":{"get":{"operationId":"getScenes","summary":"List scenes","description":"List all available scenes","tags":["Scene"],"responses":{"200":{"description":"Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Create a new scene > Creates a new scene ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ScenePost":{"type":"object","required":["actions","metadata","group"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene":{"post":{"operationId":"createScene","summary":"Create a new scene","description":"Creates a new scene","tags":["Scene"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenePost"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get a scene > Get details of a single scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["actions","metadata","group","speed","auto_dynamic","status"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionGet"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"},"status":{"type":"object","properties":{"active":{"type":"string","enum":["inactive","static","dynamic_palette"]}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"get":{"operationId":"getScene","summary":"Get a scene","description":"Get details of a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"responses":{"200":{"description":"Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update a scene > Update a single scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ScenePut":{"type":"object","properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"recall":{"$ref":"#/components/schemas/SceneRecall"},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"When writing active, the actions in the scene are executed on the target. dynamic_palette starts dynamic scene with colors in the Palette object.","enum":["active","dynamic_palette","static"]},"duration":{"type":"integer","description":"Transition to the scene within the timeframe given by duration"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"put":{"operationId":"updateScene","summary":"Update a scene","description":"Update a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Delete a scene > Delete a single scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"delete":{"operationId":"deleteScene","summary":"Delete a scene","description":"Delete a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Smart Scene API to manage smart scenes ## List smart scenes > List all available smart scenes ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Smart Scene","description":"API to manage smart scenes"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SmartSceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadataWithImage"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"active_timeslot":{"description":"the active time slot in execution","type":"object","properties":{"timeslot_id":{"type":"integer"},"weekday":{"$ref":"#/components/schemas/Weekday"}},"required":["timeslot_id","weekday"]},"state":{"description":"the current state of the smart scene. The default state is inactive if no recall is provided","type":"string","enum":["active","inactive"]}},"required":["metadata","group","week_timeslots","transition_duration","state"]}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/smart_scene":{"get":{"operationId":"getSmartScenes","summary":"List smart scenes","description":"List all available smart scenes","tags":["Smart Scene"],"responses":{"200":{"description":"Smart Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Create a new smart scene > Creates a new smart scene ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Smart Scene","description":"API to manage smart scenes"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"SmartScenePost":{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadataWithImage"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"recall":{"$ref":"#/components/schemas/SmartSceneRecall"}},"required":["metadata","group","week_timeslots"]},"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"SmartSceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}},"required":["action"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/smart_scene":{"post":{"operationId":"createSmartScene","summary":"Create a new smart scene","description":"Creates a new smart scene","tags":["Smart Scene"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartScenePost"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get a smart scene > Get details of a single smart scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Smart Scene","description":"API to manage smart scenes"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SmartSceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadataWithImage"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"active_timeslot":{"description":"the active time slot in execution","type":"object","properties":{"timeslot_id":{"type":"integer"},"weekday":{"$ref":"#/components/schemas/Weekday"}},"required":["timeslot_id","weekday"]},"state":{"description":"the current state of the smart scene. The default state is inactive if no recall is provided","type":"string","enum":["active","inactive"]}},"required":["metadata","group","week_timeslots","transition_duration","state"]}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/smart_scene/{sceneId}":{"get":{"operationId":"getSmartScene","summary":"Get a smart scene","description":"Get details of a single smart scene from its given `{sceneId}`","tags":["Smart Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the smart scene."}],"responses":{"200":{"description":"Smart Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update a smart scene > Update a single smart scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Smart Scene","description":"API to manage smart scenes"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"SmartScenePut":{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadata"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"recall":{"$ref":"#/components/schemas/SmartSceneOptionalRecall"}}},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"SmartSceneOptionalRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/smart_scene/{sceneId}":{"put":{"operationId":"updateSmartScene","summary":"Update a smart scene","description":"Update a single smart scene from its given `{sceneId}`","tags":["Smart Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartScenePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Delete a smart scene > Delete a single smart scene from its given \`{sceneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Smart Scene","description":"API to manage smart scenes"}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/smart_scene/{sceneId}":{"delete":{"operationId":"deleteSmartScene","summary":"Delete a smart scene","description":"Delete a single smart scene from its given `{sceneId}`","tags":["Smart Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the smart scene."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Room API to manage rooms. Rooms group devices and each device can only be part of one room. ## List rooms > List all available rooms ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Room","description":"API to manage rooms. Rooms group devices and each device can only be part of one room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RoomGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services","metadata"],"properties":{"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition of\ngrouped type.\nSupported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","required":["name","archetype"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/room":{"get":{"operationId":"getRooms","summary":"List rooms","description":"List all available rooms","tags":["Room"],"responses":{"200":{"description":"Room Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RoomGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Create room > Create a new room ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Room","description":"API to manage rooms. Rooms group devices and each device can only be part of one room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"RoomPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `room` here)"},"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/room":{"post":{"operationId":"createRoom","summary":"Create room","description":"Create a new room","tags":["Room"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get room. > Get details of a single room from its given \`{roomId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Room","description":"API to manage rooms. Rooms group devices and each device can only be part of one room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RoomGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services","metadata"],"properties":{"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition of\ngrouped type.\nSupported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","required":["name","archetype"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/room/{roomId}":{"get":{"operationId":"getRoom","summary":"Get room.","description":"Get details of a single room from its given `{roomId}`","tags":["Room"],"parameters":[{"name":"roomId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the room"}],"responses":{"200":{"description":"Room Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RoomGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update room > Update a single room from its given \`{roomId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Room","description":"API to manage rooms. Rooms group devices and each device can only be part of one room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"RoomPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `room` here)"},"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/room/{roomId}":{"put":{"operationId":"updateRoom","summary":"Update room","description":"Update a single room from its given `{roomId}`","tags":["Room"],"parameters":[{"name":"roomId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the room"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Delete room > Delete a single room from its given \`{roomId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Room","description":"API to manage rooms. Rooms group devices and each device can only be part of one room."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/room/{roomId}":{"delete":{"operationId":"deleteRoom","summary":"Delete room","description":"Delete a single room from its given `{roomId}`","tags":["Room"],"parameters":[{"name":"roomId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the room"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Zone API to manage zones. Zones group services and each service can be part of multiple zones. ## List zones > List all available zones ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Zone","description":"API to manage zones. Zones group services and each service can be part of multiple zones."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RoomGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services","metadata"],"properties":{"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition of\ngrouped type.\nSupported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","required":["name","archetype"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zone":{"get":{"operationId":"getZones","summary":"List zones","description":"List all available zones","tags":["Zone"],"responses":{"200":{"description":"Zone Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RoomGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Create zone > Create a new zone ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Zone","description":"API to manage zones. Zones group services and each service can be part of multiple zones."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"RoomPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `room` here)"},"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zone":{"post":{"operationId":"createZone","summary":"Create zone","description":"Create a new zone","tags":["Zone"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get Zone. > Get details of a single Zone from its given \`{zoneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Zone","description":"API to manage zones. Zones group services and each service can be part of multiple zones."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RoomGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services","metadata"],"properties":{"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition of\ngrouped type.\nSupported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","required":["name","archetype"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zone/{zoneId}":{"get":{"operationId":"getZone","summary":"Get Zone.","description":"Get details of a single Zone from its given `{zoneId}`","tags":["Zone"],"parameters":[{"name":"zoneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the Zone"}],"responses":{"200":{"description":"Zone Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RoomGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update Zone > Update a single Zone from its given \`{zoneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Zone","description":"API to manage zones. Zones group services and each service can be part of multiple zones."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"RoomPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `room` here)"},"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zone/{zoneId}":{"put":{"operationId":"updateZone","summary":"Update Zone","description":"Update a single Zone from its given `{zoneId}`","tags":["Zone"],"parameters":[{"name":"zoneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the Zone"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Delete Zone > Delete a single Zone from its given \`{zoneId}\` ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Zone","description":"API to manage zones. Zones group services and each service can be part of multiple zones."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zone/{zoneId}":{"delete":{"operationId":"deleteZone","summary":"Delete Zone","description":"Delete a single Zone from its given `{zoneId}`","tags":["Zone"],"parameters":[{"name":"zoneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the Zone"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Temperature API to manage temperature services. These are offered by devices with temperature sensing capabilities. ## List temperatures > List all temperatures ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Temperature","description":"API to manage temperature services. These are offered by devices with temperature sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"TemperatureGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","temperature"],"properties":{"enabled":{"type":"boolean","description":"`true` when sensor is activated, `false` when deactivated\n"},"temperature":{"type":"object","required":["temperature","temperature_valid"],"properties":{"temperature":{"type":"number","description":"Deprecated. Moved to Temperature_report/temperature"},"temperature_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in temperature is valid"},"temperature_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"temperature":{"type":"number","description":"Temperature in 1.00 degrees Celsius"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/temperature":{"get":{"operationId":"getTemperatures","summary":"List temperatures","description":"List all temperatures","tags":["Temperature"],"responses":{"200":{"description":"Temperature Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TemperatureGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get temperature sensor information > Get details of a single temperature sensor from its given \`{temperatureId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Temperature","description":"API to manage temperature services. These are offered by devices with temperature sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"TemperatureGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","temperature"],"properties":{"enabled":{"type":"boolean","description":"`true` when sensor is activated, `false` when deactivated\n"},"temperature":{"type":"object","required":["temperature","temperature_valid"],"properties":{"temperature":{"type":"number","description":"Deprecated. Moved to Temperature_report/temperature"},"temperature_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in temperature is valid"},"temperature_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"temperature":{"type":"number","description":"Temperature in 1.00 degrees Celsius"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/temperature/{temperatureId}":{"get":{"operationId":"getTemperature","summary":"Get temperature sensor information","description":"Get details of a single temperature sensor from its given `{temperatureId}`.","tags":["Temperature"],"parameters":[{"name":"temperatureId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the temperature sensor"}],"responses":{"200":{"description":"Temperature Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TemperatureGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update temperature sensor > Update a temperature sensor from its given \`{temperatureId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Temperature","description":"API to manage temperature services. These are offered by devices with temperature sensing capabilities."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"TemperaturePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `temperature` here)","enum":["temperature"]},"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/temperature/{temperatureId}":{"put":{"operationId":"updateTemperature","summary":"Update temperature sensor","description":"Update a temperature sensor from its given `{temperatureId}`.","tags":["Temperature"],"parameters":[{"name":"temperatureId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the temperature sensor"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemperaturePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Button API to manage button services. These are offered by devices with buttons. ## List buttons. > List all available button resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Button","description":"API to manage button services. These are offered by devices with buttons."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"button":{"type":"object","properties":{"button_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"The button event that was triggered."}}},"last_event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"Deprecated. Use button_report instead."},"repeat_interval":{"type":"integer","description":"Interval in milliseconds for repeat events."},"event_values":{"type":"array","items":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"]},"description":"List of supported button events."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/button":{"get":{"operationId":"getButtons","summary":"List buttons.","description":"List all available button resources.","tags":["Button"],"responses":{"200":{"description":"Button Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ButtonGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get button. > Get details of a single button resource from its given \`{buttonId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Button","description":"API to manage button services. These are offered by devices with buttons."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"button":{"type":"object","properties":{"button_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"The button event that was triggered."}}},"last_event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"Deprecated. Use button_report instead."},"repeat_interval":{"type":"integer","description":"Interval in milliseconds for repeat events."},"event_values":{"type":"array","items":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"]},"description":"List of supported button events."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/button/{buttonId}":{"get":{"operationId":"getButton","summary":"Get button.","description":"Get details of a single button resource from its given `{buttonId}`.","tags":["Button"],"parameters":[{"name":"buttonId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the button"}],"responses":{"200":{"description":"Button Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ButtonGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update button. > Update a single button resource from its given \`{buttonId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Button","description":"API to manage button services. These are offered by devices with buttons."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ButtonPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `button` here)"},"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"button":{"type":"object","properties":{"repeat_interval":{"type":"integer","description":"Interval in milliseconds for repeat events."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/button/{buttonId}":{"put":{"operationId":"updateButton","summary":"Update button.","description":"Update a single button resource from its given `{buttonId}`.","tags":["Button"],"parameters":[{"name":"buttonId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the button"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ButtonPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Bell Button API to manage bell button services. ## List bell buttons. > List all available bell button resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BellButton","description":"API to manage bell button services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BellButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"bell":{"type":"object","properties":{"bell_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["ring"],"description":"The bell button event that was triggered."}}},"last_event":{"type":"string","enum":["ring"],"description":"Deprecated. Use bell_report instead."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bell_button":{"get":{"operationId":"getBellButtons","summary":"List bell buttons.","description":"List all available bell button resources.","tags":["BellButton"],"responses":{"200":{"description":"BellButton Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BellButtonGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get bell button. > Get details of a single bell button resource from its given \`{bellButtonId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BellButton","description":"API to manage bell button services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BellButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"bell":{"type":"object","properties":{"bell_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["ring"],"description":"The bell button event that was triggered."}}},"last_event":{"type":"string","enum":["ring"],"description":"Deprecated. Use bell_report instead."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bell_button/{bellButtonId}":{"get":{"operationId":"getBellButton","summary":"Get bell button.","description":"Get details of a single bell button resource from its given `{bellButtonId}`.","tags":["BellButton"],"parameters":[{"name":"bellButtonId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the bell button"}],"responses":{"200":{"description":"BellButton Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BellButtonGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update bell button. > Update a single bell button resource from its given \`{bellButtonId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BellButton","description":"API to manage bell button services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"BellButtonPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `bell_button` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/bell_button/{bellButtonId}":{"put":{"operationId":"updateBellButton","summary":"Update bell button.","description":"Update a single bell button resource from its given `{bellButtonId}`.","tags":["BellButton"],"parameters":[{"name":"bellButtonId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the bell button"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BellButtonPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Relative Rotary API to manage relative rotary controls. ## List relative rotary controls. > List all available relative rotary resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"RelativeRotary","description":"API to manage relative rotary controls."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RelativeRotaryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"relative_rotary":{"type":"object","properties":{"rotary_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"action":{"type":"string","enum":["start","repeat"],"description":"Type of rotary event."},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"],"description":"Direction of rotation."},"steps":{"type":"integer","description":"Amount of rotation since last event in case of repeat."},"duration":{"type":"integer","description":"Duration of rotation since last event in milliseconds."}}}}},"last_event":{"type":"object","description":"Deprecated. Use rotary_report instead.","properties":{"action":{"type":"string","enum":["start","repeat"]},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"]},"steps":{"type":"integer"},"duration":{"type":"integer"}}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/relative_rotary":{"get":{"operationId":"getRelativeRotaries","summary":"List relative rotary controls.","description":"List all available relative rotary resources.","tags":["RelativeRotary"],"responses":{"200":{"description":"RelativeRotary Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RelativeRotaryGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get relative rotary. > Get details of a single relative rotary resource from its given \`{relativeRotaryId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"RelativeRotary","description":"API to manage relative rotary controls."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"RelativeRotaryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"relative_rotary":{"type":"object","properties":{"rotary_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"action":{"type":"string","enum":["start","repeat"],"description":"Type of rotary event."},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"],"description":"Direction of rotation."},"steps":{"type":"integer","description":"Amount of rotation since last event in case of repeat."},"duration":{"type":"integer","description":"Duration of rotation since last event in milliseconds."}}}}},"last_event":{"type":"object","description":"Deprecated. Use rotary_report instead.","properties":{"action":{"type":"string","enum":["start","repeat"]},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"]},"steps":{"type":"integer"},"duration":{"type":"integer"}}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/relative_rotary/{relativeRotaryId}":{"get":{"operationId":"getRelativeRotary","summary":"Get relative rotary.","description":"Get details of a single relative rotary resource from its given `{relativeRotaryId}`.","tags":["RelativeRotary"],"parameters":[{"name":"relativeRotaryId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the relative rotary"}],"responses":{"200":{"description":"RelativeRotary Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RelativeRotaryGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update relative rotary. > Update a single relative rotary resource from its given \`{relativeRotaryId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"RelativeRotary","description":"API to manage relative rotary controls."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"RelativeRotaryPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `relative_rotary` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/relative_rotary/{relativeRotaryId}":{"put":{"operationId":"updateRelativeRotary","summary":"Update relative rotary.","description":"Update a single relative rotary resource from its given `{relativeRotaryId}`.","tags":["RelativeRotary"],"parameters":[{"name":"relativeRotaryId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the relative rotary"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelativeRotaryPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Contact API to manage contact sensors. ## List contact sensors. > List all available contact sensor resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Contact","description":"API to manage contact sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ContactGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"contact_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"state":{"type":"string","enum":["contact","no_contact"],"description":"State of the contact sensor."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/contact":{"get":{"operationId":"getContacts","summary":"List contact sensors.","description":"List all available contact sensor resources.","tags":["Contact"],"responses":{"200":{"description":"Contact Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get contact sensor. > Get details of a single contact sensor resource from its given \`{contactId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Contact","description":"API to manage contact sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ContactGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"contact_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"state":{"type":"string","enum":["contact","no_contact"],"description":"State of the contact sensor."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/contact/{contactId}":{"get":{"operationId":"getContact","summary":"Get contact sensor.","description":"Get details of a single contact sensor resource from its given `{contactId}`.","tags":["Contact"],"parameters":[{"name":"contactId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the contact sensor"}],"responses":{"200":{"description":"Contact Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update contact sensor. > Update a single contact sensor resource from its given \`{contactId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Contact","description":"API to manage contact sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ContactPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `contact` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/contact/{contactId}":{"put":{"operationId":"updateContact","summary":"Update contact sensor.","description":"Update a single contact sensor resource from its given `{contactId}`.","tags":["Contact"],"parameters":[{"name":"contactId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the contact sensor"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Tamper API to manage tamper detection sensors. ## List tamper sensors. > List all available tamper sensor resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Tamper","description":"API to manage tamper detection sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"TamperGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"tamper_reports":{"type":"array","items":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"source":{"type":"string","description":"Source of the tamper event."},"state":{"type":"string","enum":["tampered","not_tampered"],"description":"State of the tamper sensor."}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/tamper":{"get":{"operationId":"getTampers","summary":"List tamper sensors.","description":"List all available tamper sensor resources.","tags":["Tamper"],"responses":{"200":{"description":"Tamper Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TamperGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get tamper sensor. > Get details of a single tamper sensor resource from its given \`{tamperId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Tamper","description":"API to manage tamper detection sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"TamperGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"tamper_reports":{"type":"array","items":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"source":{"type":"string","description":"Source of the tamper event."},"state":{"type":"string","enum":["tampered","not_tampered"],"description":"State of the tamper sensor."}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/tamper/{tamperId}":{"get":{"operationId":"getTamper","summary":"Get tamper sensor.","description":"Get details of a single tamper sensor resource from its given `{tamperId}`.","tags":["Tamper"],"parameters":[{"name":"tamperId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the tamper sensor"}],"responses":{"200":{"description":"Tamper Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TamperGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update tamper sensor. > Update a single tamper sensor resource from its given \`{tamperId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Tamper","description":"API to manage tamper detection sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"TamperPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `tamper` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/tamper/{tamperId}":{"put":{"operationId":"updateTamper","summary":"Update tamper sensor.","description":"Update a single tamper sensor resource from its given `{tamperId}`.","tags":["Tamper"],"parameters":[{"name":"tamperId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the tamper sensor"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TamperPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Camera Motion API to manage camera motion detection. ## List camera motion sensors. > List all available camera motion sensors resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"CameraMotion","description":"API to manage camera motion detection."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"CameraMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"motion":{"type":"boolean","description":"True if motion is detected."}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/camera_motion":{"get":{"operationId":"getCameraMotions","summary":"List camera motion sensors.","description":"List all available camera motion sensors resources.","tags":["CameraMotion"],"responses":{"200":{"description":"CameraMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CameraMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get camera motion. > Get details of a single camera motion resource from its given \`{cameraMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"CameraMotion","description":"API to manage camera motion detection."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"CameraMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"motion":{"type":"boolean","description":"True if motion is detected."}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/camera_motion/{cameraMotionId}":{"get":{"operationId":"getCameraMotion","summary":"Get camera motion.","description":"Get details of a single camera motion resource from its given `{cameraMotionId}`.","tags":["CameraMotion"],"parameters":[{"name":"cameraMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the camera motion"}],"responses":{"200":{"description":"CameraMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CameraMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update camera motion. > Update a single camera motion resource from its given \`{cameraMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"CameraMotion","description":"API to manage camera motion detection."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"CameraMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `camera_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/camera_motion/{cameraMotionId}":{"put":{"operationId":"updateCameraMotion","summary":"Update camera motion.","description":"Update a single camera motion resource from its given `{cameraMotionId}`.","tags":["CameraMotion"],"parameters":[{"name":"cameraMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the camera motion"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CameraMotionPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Grouped Motion API to manage grouped motion sensors. ## List grouped motion sensors. > List all available grouped motion sensors resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedMotion","description":"API to manage grouped motion sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected in any of the grouped sensors."},"motion_valid":{"type":"boolean","description":"True if any of the grouped motion sensors are reporting valid motion."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_motion":{"get":{"operationId":"getGroupedMotions","summary":"List grouped motion sensors.","description":"List all available grouped motion sensors resources.","tags":["GroupedMotion"],"responses":{"200":{"description":"GroupedMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get grouped motion. > Get details of a single grouped motion resource from its given \`{groupedMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedMotion","description":"API to manage grouped motion sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected in any of the grouped sensors."},"motion_valid":{"type":"boolean","description":"True if any of the grouped motion sensors are reporting valid motion."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_motion/{groupedMotionId}":{"get":{"operationId":"getGroupedMotion","summary":"Get grouped motion.","description":"Get details of a single grouped motion resource from its given `{groupedMotionId}`.","tags":["GroupedMotion"],"parameters":[{"name":"groupedMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped motion"}],"responses":{"200":{"description":"GroupedMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update grouped motion. > Update a single grouped motion resource from its given \`{groupedMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedMotion","description":"API to manage grouped motion sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GroupedMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_motion` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_motion/{groupedMotionId}":{"put":{"operationId":"updateGroupedMotion","summary":"Update grouped motion.","description":"Update a single grouped motion resource from its given `{groupedMotionId}`.","tags":["GroupedMotion"],"parameters":[{"name":"groupedMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped motion"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedMotionPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Grouped Light Level API to manage grouped light level sensors. ## List grouped light level sensors. > List all available grouped light level sensors resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLightLevel","description":"API to manage grouped light level sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"light":{"type":"object","properties":{"light_level":{"type":"integer","description":"Light level in 10000*log10(lux)+1 measured by sensor."},"light_level_valid":{"type":"boolean","description":"True if light level is valid."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light_level":{"get":{"operationId":"getGroupedLightLevels","summary":"List grouped light level sensors.","description":"List all available grouped light level sensors resources.","tags":["GroupedLightLevel"],"responses":{"200":{"description":"GroupedLightLevel Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightLevelGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get grouped light level. > Get details of a single grouped light level resource from its given \`{groupedLightLevelId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLightLevel","description":"API to manage grouped light level sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GroupedLightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"light":{"type":"object","properties":{"light_level":{"type":"integer","description":"Light level in 10000*log10(lux)+1 measured by sensor."},"light_level_valid":{"type":"boolean","description":"True if light level is valid."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light_level/{groupedLightLevelId}":{"get":{"operationId":"getGroupedLightLevel","summary":"Get grouped light level.","description":"Get details of a single grouped light level resource from its given `{groupedLightLevelId}`.","tags":["GroupedLightLevel"],"parameters":[{"name":"groupedLightLevelId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped light level"}],"responses":{"200":{"description":"GroupedLightLevel Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupedLightLevelGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update grouped light level. > Update a single grouped light level resource from its given \`{groupedLightLevelId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GroupedLightLevel","description":"API to manage grouped light level sensors."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GroupedLightLevelPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_light_level` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/grouped_light_level/{groupedLightLevelId}":{"put":{"operationId":"updateGroupedLightLevel","summary":"Update grouped light level.","description":"Update a single grouped light level resource from its given `{groupedLightLevelId}`.","tags":["GroupedLightLevel"],"parameters":[{"name":"groupedLightLevelId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the grouped light level"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedLightLevelPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Convenience Area Motion API to manage convenience area motion. ## List convenience area motion sensors. > List all available convenience area motion sensors resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ConvenienceAreaMotion","description":"API to manage convenience area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ConvenienceAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/convenience_area_motion":{"get":{"operationId":"getConvenienceAreaMotions","summary":"List convenience area motion sensors.","description":"List all available convenience area motion sensors resources.","tags":["ConvenienceAreaMotion"],"responses":{"200":{"description":"ConvenienceAreaMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConvenienceAreaMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get convenience area motion. > Get details of a single convenience area motion resource from its given \`{convenienceAreaMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ConvenienceAreaMotion","description":"API to manage convenience area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ConvenienceAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId}":{"get":{"operationId":"getConvenienceAreaMotion","summary":"Get convenience area motion.","description":"Get details of a single convenience area motion resource from its given `{convenienceAreaMotionId}`.","tags":["ConvenienceAreaMotion"],"parameters":[{"name":"convenienceAreaMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the convenience area motion"}],"responses":{"200":{"description":"ConvenienceAreaMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConvenienceAreaMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update convenience area motion. > Update a single convenience area motion resource from its given \`{convenienceAreaMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ConvenienceAreaMotion","description":"API to manage convenience area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ConvenienceAreaMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `convenience_area_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId}":{"put":{"operationId":"updateConvenienceAreaMotion","summary":"Update convenience area motion.","description":"Update a single convenience area motion resource from its given `{convenienceAreaMotionId}`.","tags":["ConvenienceAreaMotion"],"parameters":[{"name":"convenienceAreaMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the convenience area motion"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvenienceAreaMotionPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Security Area Motion API to manage security area motion. ## List security area motion sensors. > List all available security area motion sensors resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"SecurityAreaMotion","description":"API to manage security area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SecurityAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/security_area_motion":{"get":{"operationId":"getSecurityAreaMotions","summary":"List security area motion sensors.","description":"List all available security area motion sensors resources.","tags":["SecurityAreaMotion"],"responses":{"200":{"description":"SecurityAreaMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SecurityAreaMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get security area motion. > Get details of a single security area motion resource from its given \`{securityAreaMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"SecurityAreaMotion","description":"API to manage security area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SecurityAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/security_area_motion/{securityAreaMotionId}":{"get":{"operationId":"getSecurityAreaMotion","summary":"Get security area motion.","description":"Get details of a single security area motion resource from its given `{securityAreaMotionId}`.","tags":["SecurityAreaMotion"],"parameters":[{"name":"securityAreaMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the security area motion"}],"responses":{"200":{"description":"SecurityAreaMotion Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SecurityAreaMotionGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update security area motion. > Update a single security area motion resource from its given \`{securityAreaMotionId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"SecurityAreaMotion","description":"API to manage security area motion."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"SecurityAreaMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `security_area_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/security_area_motion/{securityAreaMotionId}":{"put":{"operationId":"updateSecurityAreaMotion","summary":"Update security area motion.","description":"Update a single security area motion resource from its given `{securityAreaMotionId}`.","tags":["SecurityAreaMotion"],"parameters":[{"name":"securityAreaMotionId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the security area motion"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityAreaMotionPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Motion Area Candidate API to manage motion area candidates. ## List motion area candidates. > List all available motion area candidates resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaCandidate","description":"API to manage motion area candidates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionAreaCandidateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensor resources that are candidates for this area."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_candidate":{"get":{"operationId":"getMotionAreaCandidates","summary":"List motion area candidates.","description":"List all available motion area candidates resources.","tags":["MotionAreaCandidate"],"responses":{"200":{"description":"MotionAreaCandidate Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionAreaCandidateGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get motion area candidate. > Get details of a single motion area candidate resource from its given \`{motionAreaCandidateId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaCandidate","description":"API to manage motion area candidates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionAreaCandidateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensor resources that are candidates for this area."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_candidate/{motionAreaCandidateId}":{"get":{"operationId":"getMotionAreaCandidate","summary":"Get motion area candidate.","description":"Get details of a single motion area candidate resource from its given `{motionAreaCandidateId}`.","tags":["MotionAreaCandidate"],"parameters":[{"name":"motionAreaCandidateId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the motion area candidate"}],"responses":{"200":{"description":"MotionAreaCandidate Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionAreaCandidateGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update motion area candidate. > Update a single motion area candidate resource from its given \`{motionAreaCandidateId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaCandidate","description":"API to manage motion area candidates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"MotionAreaCandidatePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion_area_candidate` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_candidate/{motionAreaCandidateId}":{"put":{"operationId":"updateMotionAreaCandidate","summary":"Update motion area candidate.","description":"Update a single motion area candidate resource from its given `{motionAreaCandidateId}`.","tags":["MotionAreaCandidate"],"parameters":[{"name":"motionAreaCandidateId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the motion area candidate"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MotionAreaCandidatePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Motion Area Configuration API to manage motion area configuration. ## List motion area configurations. > List all available motion area configurations resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaConfiguration","description":"API to manage motion area configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionAreaConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when configuration is active."},"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensors in this area configuration."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_configuration":{"get":{"operationId":"getMotionAreaConfigurations","summary":"List motion area configurations.","description":"List all available motion area configurations resources.","tags":["MotionAreaConfiguration"],"responses":{"200":{"description":"MotionAreaConfiguration Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionAreaConfigurationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get motion area configuration. > Get details of a single motion area configuration resource from its given \`{motionAreaConfigurationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaConfiguration","description":"API to manage motion area configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MotionAreaConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when configuration is active."},"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensors in this area configuration."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_configuration/{motionAreaConfigurationId}":{"get":{"operationId":"getMotionAreaConfiguration","summary":"Get motion area configuration.","description":"Get details of a single motion area configuration resource from its given `{motionAreaConfigurationId}`.","tags":["MotionAreaConfiguration"],"parameters":[{"name":"motionAreaConfigurationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the motion area configuration"}],"responses":{"200":{"description":"MotionAreaConfiguration Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MotionAreaConfigurationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update motion area configuration. > Update a single motion area configuration resource from its given \`{motionAreaConfigurationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MotionAreaConfiguration","description":"API to manage motion area configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"MotionAreaConfigurationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion_area_configuration` here)"},"enabled":{"type":"boolean","description":"True when configuration is active."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/motion_area_configuration/{motionAreaConfigurationId}":{"put":{"operationId":"updateMotionAreaConfiguration","summary":"Update motion area configuration.","description":"Update a single motion area configuration resource from its given `{motionAreaConfigurationId}`.","tags":["MotionAreaConfiguration"],"parameters":[{"name":"motionAreaConfigurationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the motion area configuration"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MotionAreaConfigurationPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Zigbee Connectivity API to manage zigbee connectivity status. ## List zigbee connectivity. > List all available zigbee connectivity resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeConnectivity","description":"API to manage zigbee connectivity status."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZigbeeConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue","unidirectional_incoming"],"description":"Current connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"channel":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"value":{"type":"string","enum":["channel_11","channel_15","channel_20","channel_25"],"description":"Current zigbee channel."}}},"extended_pan_id":{"type":"string","description":"Extended PAN ID of the zigbee network."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_connectivity":{"get":{"operationId":"getZigbeeConnectivities","summary":"List zigbee connectivity.","description":"List all available zigbee connectivity resources.","tags":["ZigbeeConnectivity"],"responses":{"200":{"description":"ZigbeeConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZigbeeConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get zigbee connectivity. > Get details of a single zigbee connectivity resource from its given \`{zigbeeConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeConnectivity","description":"API to manage zigbee connectivity status."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZigbeeConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue","unidirectional_incoming"],"description":"Current connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"channel":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"value":{"type":"string","enum":["channel_11","channel_15","channel_20","channel_25"],"description":"Current zigbee channel."}}},"extended_pan_id":{"type":"string","description":"Extended PAN ID of the zigbee network."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_connectivity/{zigbeeConnectivityId}":{"get":{"operationId":"getZigbeeConnectivity","summary":"Get zigbee connectivity.","description":"Get details of a single zigbee connectivity resource from its given `{zigbeeConnectivityId}`.","tags":["ZigbeeConnectivity"],"parameters":[{"name":"zigbeeConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the zigbee connectivity"}],"responses":{"200":{"description":"ZigbeeConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZigbeeConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update zigbee connectivity. > Update a single zigbee connectivity resource from its given \`{zigbeeConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeConnectivity","description":"API to manage zigbee connectivity status."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ZigbeeConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zigbee_connectivity` here)"},"channel":{"type":"object","properties":{"value":{"type":"string","enum":["channel_11","channel_15","channel_20","channel_25"],"description":"Zigbee channel to set."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_connectivity/{zigbeeConnectivityId}":{"put":{"operationId":"updateZigbeeConnectivity","summary":"Update zigbee connectivity.","description":"Update a single zigbee connectivity resource from its given `{zigbeeConnectivityId}`.","tags":["ZigbeeConnectivity"],"parameters":[{"name":"zigbeeConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the zigbee connectivity"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZigbeeConnectivityPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Zgp Connectivity API to manage Zigbee Green Power connectivity. ## List ZGP connectivity. > List all available Zigbee Green Power connectivity resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZgpConnectivity","description":"API to manage Zigbee Green Power connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZgpConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current connectivity status of the device."},"source_id":{"type":"string","description":"Source ID of the ZGP device."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zgp_connectivity":{"get":{"operationId":"getZgpConnectivities","summary":"List ZGP connectivity.","description":"List all available Zigbee Green Power connectivity resources.","tags":["ZgpConnectivity"],"responses":{"200":{"description":"ZgpConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZgpConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get ZGP connectivity. > Get details of a single ZGP connectivity resource from its given \`{zgpConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZgpConnectivity","description":"API to manage Zigbee Green Power connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZgpConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current connectivity status of the device."},"source_id":{"type":"string","description":"Source ID of the ZGP device."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zgp_connectivity/{zgpConnectivityId}":{"get":{"operationId":"getZgpConnectivity","summary":"Get ZGP connectivity.","description":"Get details of a single ZGP connectivity resource from its given `{zgpConnectivityId}`.","tags":["ZgpConnectivity"],"parameters":[{"name":"zgpConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the ZGP connectivity"}],"responses":{"200":{"description":"ZgpConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZgpConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update ZGP connectivity. > Update a single ZGP connectivity resource from its given \`{zgpConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZgpConnectivity","description":"API to manage Zigbee Green Power connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ZgpConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zgp_connectivity` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zgp_connectivity/{zgpConnectivityId}":{"put":{"operationId":"updateZgpConnectivity","summary":"Update ZGP connectivity.","description":"Update a single ZGP connectivity resource from its given `{zgpConnectivityId}`.","tags":["ZgpConnectivity"],"parameters":[{"name":"zgpConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the ZGP connectivity"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZgpConnectivityPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Wifi Connectivity API to manage WiFi connectivity. ## List WiFi connectivity. > List all available WiFi connectivity resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"WifiConnectivity","description":"API to manage WiFi connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"WifiConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current WiFi connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"signal_strength":{"type":"object","properties":{"status":{"type":"string","enum":["good","fair","bad"]},"value":{"type":"integer","description":"Signal strength in dBm."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/wifi_connectivity":{"get":{"operationId":"getWifiConnectivities","summary":"List WiFi connectivity.","description":"List all available WiFi connectivity resources.","tags":["WifiConnectivity"],"responses":{"200":{"description":"WifiConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WifiConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get WiFi connectivity. > Get details of a single WiFi connectivity resource from its given \`{wifiConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"WifiConnectivity","description":"API to manage WiFi connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"WifiConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current WiFi connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"signal_strength":{"type":"object","properties":{"status":{"type":"string","enum":["good","fair","bad"]},"value":{"type":"integer","description":"Signal strength in dBm."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/wifi_connectivity/{wifiConnectivityId}":{"get":{"operationId":"getWifiConnectivity","summary":"Get WiFi connectivity.","description":"Get details of a single WiFi connectivity resource from its given `{wifiConnectivityId}`.","tags":["WifiConnectivity"],"parameters":[{"name":"wifiConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the WiFi connectivity"}],"responses":{"200":{"description":"WifiConnectivity Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WifiConnectivityGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update WiFi connectivity. > Update a single WiFi connectivity resource from its given \`{wifiConnectivityId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"WifiConnectivity","description":"API to manage WiFi connectivity."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"WifiConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `wifi_connectivity` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/wifi_connectivity/{wifiConnectivityId}":{"put":{"operationId":"updateWifiConnectivity","summary":"Update WiFi connectivity.","description":"Update a single WiFi connectivity resource from its given `{wifiConnectivityId}`.","tags":["WifiConnectivity"],"parameters":[{"name":"wifiConnectivityId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the WiFi connectivity"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WifiConnectivityPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Zigbee Device Discovery API to manage zigbee device discovery. ## List zigbee device discovery. > List all available zigbee device discovery resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeDeviceDiscovery","description":"API to manage zigbee device discovery."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZigbeeDeviceDiscoveryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["active","ready"],"description":"Current status of the device discovery."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_device_discovery":{"get":{"operationId":"getZigbeeDeviceDiscoveries","summary":"List zigbee device discovery.","description":"List all available zigbee device discovery resources.","tags":["ZigbeeDeviceDiscovery"],"responses":{"200":{"description":"ZigbeeDeviceDiscovery Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZigbeeDeviceDiscoveryGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get zigbee device discovery. > Get details of a single zigbee device discovery resource from its given \`{zigbeeDeviceDiscoveryId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeDeviceDiscovery","description":"API to manage zigbee device discovery."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ZigbeeDeviceDiscoveryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["active","ready"],"description":"Current status of the device discovery."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId}":{"get":{"operationId":"getZigbeeDeviceDiscovery","summary":"Get zigbee device discovery.","description":"Get details of a single zigbee device discovery resource from its given `{zigbeeDeviceDiscoveryId}`.","tags":["ZigbeeDeviceDiscovery"],"parameters":[{"name":"zigbeeDeviceDiscoveryId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the zigbee device discovery"}],"responses":{"200":{"description":"ZigbeeDeviceDiscovery Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ZigbeeDeviceDiscoveryGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update zigbee device discovery. > Update a single zigbee device discovery resource from its given \`{zigbeeDeviceDiscoveryId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ZigbeeDeviceDiscovery","description":"API to manage zigbee device discovery."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ZigbeeDeviceDiscoveryPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zigbee_device_discovery` here)"},"action":{"type":"object","properties":{"action_type":{"type":"string","enum":["search"],"description":"Action to trigger device discovery."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId}":{"put":{"operationId":"updateZigbeeDeviceDiscovery","summary":"Update zigbee device discovery.","description":"Update a single zigbee device discovery resource from its given `{zigbeeDeviceDiscoveryId}`.","tags":["ZigbeeDeviceDiscovery"],"parameters":[{"name":"zigbeeDeviceDiscoveryId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the zigbee device discovery"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZigbeeDeviceDiscoveryPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Homekit API to manage Apple HomeKit integration. ## List HomeKit. > List all available HomeKit resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Homekit","description":"API to manage Apple HomeKit integration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"HomekitGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","pairing","unpaired"],"description":"Current HomeKit pairing status."},"action":{"type":"string","enum":["none"],"description":"Current HomeKit action."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/homekit":{"get":{"operationId":"getHomekits","summary":"List HomeKit.","description":"List all available HomeKit resources.","tags":["Homekit"],"responses":{"200":{"description":"Homekit Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HomekitGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get homekit. > Get details of a single homekit resource from its given \`{homekitId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Homekit","description":"API to manage Apple HomeKit integration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"HomekitGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","pairing","unpaired"],"description":"Current HomeKit pairing status."},"action":{"type":"string","enum":["none"],"description":"Current HomeKit action."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/homekit/{homekitId}":{"get":{"operationId":"getHomekit","summary":"Get homekit.","description":"Get details of a single homekit resource from its given `{homekitId}`.","tags":["Homekit"],"parameters":[{"name":"homekitId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the homekit"}],"responses":{"200":{"description":"Homekit Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HomekitGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update homekit. > Update a single homekit resource from its given \`{homekitId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Homekit","description":"API to manage Apple HomeKit integration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"HomekitPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `homekit` here)"},"action":{"type":"string","enum":["homekit_reset"],"description":"Action to trigger on the HomeKit integration."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/homekit/{homekitId}":{"put":{"operationId":"updateHomekit","summary":"Update homekit.","description":"Update a single homekit resource from its given `{homekitId}`.","tags":["Homekit"],"parameters":[{"name":"homekitId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the homekit"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HomekitPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Matter API to manage Matter protocol support. ## List Matter. > List all available Matter resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Matter","description":"API to manage Matter protocol support."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MatterGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"has_qr_code":{"type":"boolean","description":"Indicates if QR code for Matter commissioning is available."},"max_fabrics":{"type":"integer","description":"Maximum number of fabrics that can be added."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter":{"get":{"operationId":"getMatters","summary":"List Matter.","description":"List all available Matter resources.","tags":["Matter"],"responses":{"200":{"description":"Matter Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatterGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get matter. > Get details of a single matter resource from its given \`{matterId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Matter","description":"API to manage Matter protocol support."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MatterGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"has_qr_code":{"type":"boolean","description":"Indicates if QR code for Matter commissioning is available."},"max_fabrics":{"type":"integer","description":"Maximum number of fabrics that can be added."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter/{matterId}":{"get":{"operationId":"getMatter","summary":"Get matter.","description":"Get details of a single matter resource from its given `{matterId}`.","tags":["Matter"],"parameters":[{"name":"matterId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the matter"}],"responses":{"200":{"description":"Matter Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatterGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update matter. > Update a single matter resource from its given \`{matterId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Matter","description":"API to manage Matter protocol support."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"MatterPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `matter` here)"},"action":{"type":"object","properties":{"action_type":{"type":"string","enum":["matter_reset"],"description":"Action to trigger on the Matter integration."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter/{matterId}":{"put":{"operationId":"updateMatter","summary":"Update matter.","description":"Update a single matter resource from its given `{matterId}`.","tags":["Matter"],"parameters":[{"name":"matterId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the matter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatterPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Matter Fabric API to manage Matter fabric configuration. ## List Matter fabric. > List all available Matter fabric resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MatterFabric","description":"API to manage Matter fabric configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MatterFabricGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","timedout"],"description":"Current Matter fabric status."},"fabric_data":{"type":"object","properties":{"label":{"type":"string","description":"Label of the fabric."},"vendor_id":{"type":"integer","description":"Vendor ID of the commissioning controller."}}},"creation_time":{"type":"string","format":"date-time","description":"Timestamp when the fabric was created."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter_fabric":{"get":{"operationId":"getMatterFabrics","summary":"List Matter fabric.","description":"List all available Matter fabric resources.","tags":["MatterFabric"],"responses":{"200":{"description":"MatterFabric Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatterFabricGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get matter fabric. > Get details of a single matter fabric resource from its given \`{matterFabricId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MatterFabric","description":"API to manage Matter fabric configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"MatterFabricGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","timedout"],"description":"Current Matter fabric status."},"fabric_data":{"type":"object","properties":{"label":{"type":"string","description":"Label of the fabric."},"vendor_id":{"type":"integer","description":"Vendor ID of the commissioning controller."}}},"creation_time":{"type":"string","format":"date-time","description":"Timestamp when the fabric was created."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter_fabric/{matterFabricId}":{"get":{"operationId":"getMatterFabric","summary":"Get matter fabric.","description":"Get details of a single matter fabric resource from its given `{matterFabricId}`.","tags":["MatterFabric"],"parameters":[{"name":"matterFabricId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the matter fabric"}],"responses":{"200":{"description":"MatterFabric Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatterFabricGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update matter fabric. > Update a single matter fabric resource from its given \`{matterFabricId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"MatterFabric","description":"API to manage Matter fabric configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"MatterFabricPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `matter_fabric` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/matter_fabric/{matterFabricId}":{"put":{"operationId":"updateMatterFabric","summary":"Update matter fabric.","description":"Update a single matter fabric resource from its given `{matterFabricId}`.","tags":["MatterFabric"],"parameters":[{"name":"matterFabricId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the matter fabric"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatterFabricPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Entertainment API to manage entertainment services. ## List entertainment. > List all available entertainment resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Entertainment","description":"API to manage entertainment services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"EntertainmentGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"renderer":{"type":"boolean","description":"Indicates if the device can be used for entertainment streaming."},"proxy":{"type":"boolean","description":"Indicates if the device is acting as entertainment proxy."},"max_streams":{"type":"integer","description":"Maximum number of streams this device supports."},"segments":{"type":"object","properties":{"configurable":{"type":"boolean"},"max_segments":{"type":"integer"},"segments":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer"},"length":{"type":"integer"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment":{"get":{"operationId":"getEntertainments","summary":"List entertainment.","description":"List all available entertainment resources.","tags":["Entertainment"],"responses":{"200":{"description":"Entertainment Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntertainmentGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get entertainment. > Get details of a single entertainment resource from its given \`{entertainmentId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Entertainment","description":"API to manage entertainment services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"EntertainmentGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"renderer":{"type":"boolean","description":"Indicates if the device can be used for entertainment streaming."},"proxy":{"type":"boolean","description":"Indicates if the device is acting as entertainment proxy."},"max_streams":{"type":"integer","description":"Maximum number of streams this device supports."},"segments":{"type":"object","properties":{"configurable":{"type":"boolean"},"max_segments":{"type":"integer"},"segments":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer"},"length":{"type":"integer"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment/{entertainmentId}":{"get":{"operationId":"getEntertainment","summary":"Get entertainment.","description":"Get details of a single entertainment resource from its given `{entertainmentId}`.","tags":["Entertainment"],"parameters":[{"name":"entertainmentId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the entertainment"}],"responses":{"200":{"description":"Entertainment Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntertainmentGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update entertainment. > Update a single entertainment resource from its given \`{entertainmentId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Entertainment","description":"API to manage entertainment services."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"EntertainmentPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `entertainment` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment/{entertainmentId}":{"put":{"operationId":"updateEntertainment","summary":"Update entertainment.","description":"Update a single entertainment resource from its given `{entertainmentId}`.","tags":["Entertainment"],"parameters":[{"name":"entertainmentId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the entertainment"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntertainmentPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Entertainment Configuration API to manage entertainment configuration. ## List entertainment configuration. > List all available entertainment configuration resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"EntertainmentConfiguration","description":"API to manage entertainment configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"EntertainmentConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"name":{"type":"string","description":"Human readable name of the configuration."}}},"configuration_type":{"type":"string","enum":["screen","monitor","music","3dspace","other"],"description":"Type of entertainment configuration."},"status":{"type":"string","enum":["active","inactive"],"description":"Status of the entertainment configuration."},"stream_proxy":{"type":"object","properties":{"mode":{"type":"string","enum":["auto","manual"]},"node":{"$ref":"#/components/schemas/ResourceIdentifier"}}},"channels":{"type":"array","items":{"type":"object","properties":{"channel_id":{"type":"integer"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}},"members":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"index":{"type":"integer"}}}}}}},"locations":{"type":"object","properties":{"service_locations":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"positions":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}},"light_services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment_configuration":{"get":{"operationId":"getEntertainmentConfigurations","summary":"List entertainment configuration.","description":"List all available entertainment configuration resources.","tags":["EntertainmentConfiguration"],"responses":{"200":{"description":"EntertainmentConfiguration Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntertainmentConfigurationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get entertainment configuration. > Get details of a single entertainment configuration resource from its given \`{entertainmentConfigurationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"EntertainmentConfiguration","description":"API to manage entertainment configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"EntertainmentConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"name":{"type":"string","description":"Human readable name of the configuration."}}},"configuration_type":{"type":"string","enum":["screen","monitor","music","3dspace","other"],"description":"Type of entertainment configuration."},"status":{"type":"string","enum":["active","inactive"],"description":"Status of the entertainment configuration."},"stream_proxy":{"type":"object","properties":{"mode":{"type":"string","enum":["auto","manual"]},"node":{"$ref":"#/components/schemas/ResourceIdentifier"}}},"channels":{"type":"array","items":{"type":"object","properties":{"channel_id":{"type":"integer"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}},"members":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"index":{"type":"integer"}}}}}}},"locations":{"type":"object","properties":{"service_locations":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"positions":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}},"light_services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId}":{"get":{"operationId":"getEntertainmentConfiguration","summary":"Get entertainment configuration.","description":"Get details of a single entertainment configuration resource from its given `{entertainmentConfigurationId}`.","tags":["EntertainmentConfiguration"],"parameters":[{"name":"entertainmentConfigurationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the entertainment configuration"}],"responses":{"200":{"description":"EntertainmentConfiguration Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntertainmentConfigurationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update entertainment configuration. > Update a single entertainment configuration resource from its given \`{entertainmentConfigurationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"EntertainmentConfiguration","description":"API to manage entertainment configuration."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"EntertainmentConfigurationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `entertainment_configuration` here)"},"metadata":{"type":"object","properties":{"name":{"type":"string","description":"Human readable name of the configuration."}}},"configuration_type":{"type":"string","enum":["screen","monitor","music","3dspace","other"]},"action":{"type":"string","enum":["start","stop"],"description":"Start or stop streaming."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId}":{"put":{"operationId":"updateEntertainmentConfiguration","summary":"Update entertainment configuration.","description":"Update a single entertainment configuration resource from its given `{entertainmentConfigurationId}`.","tags":["EntertainmentConfiguration"],"parameters":[{"name":"entertainmentConfigurationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the entertainment configuration"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntertainmentConfigurationPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Speaker API to manage speaker devices. ## List speaker. > List all available speaker resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Speaker","description":"API to manage speaker devices."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SpeakerGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"string","enum":["soundloop"]},"description":"Supported speaker alerts."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/speaker":{"get":{"operationId":"getSpeakers","summary":"List speaker.","description":"List all available speaker resources.","tags":["Speaker"],"responses":{"200":{"description":"Speaker Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpeakerGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get speaker. > Get details of a single speaker resource from its given \`{speakerId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Speaker","description":"API to manage speaker devices."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SpeakerGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"string","enum":["soundloop"]},"description":"Supported speaker alerts."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/speaker/{speakerId}":{"get":{"operationId":"getSpeaker","summary":"Get speaker.","description":"Get details of a single speaker resource from its given `{speakerId}`.","tags":["Speaker"],"parameters":[{"name":"speakerId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the speaker"}],"responses":{"200":{"description":"Speaker Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpeakerGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update speaker. > Update a single speaker resource from its given \`{speakerId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Speaker","description":"API to manage speaker devices."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"SpeakerPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `speaker` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/speaker/{speakerId}":{"put":{"operationId":"updateSpeaker","summary":"Update speaker.","description":"Update a single speaker resource from its given `{speakerId}`.","tags":["Speaker"],"parameters":[{"name":"speakerId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the speaker"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeakerPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Behavior Script API to manage automation scripts. ## List behavior script. > List all available behavior script resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorScript","description":"API to manage automation scripts."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BehaviorScriptGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"description":{"type":"string","description":"Description of the behavior script."},"configuration_schema":{"type":"object","description":"JSON schema for configuration."},"trigger_schema":{"type":"object","description":"JSON schema for trigger."},"state_schema":{"type":"object","description":"JSON schema for state."},"version":{"type":"string","description":"Version of the behavior script."},"metadata":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_script":{"get":{"operationId":"getBehaviorScripts","summary":"List behavior script.","description":"List all available behavior script resources.","tags":["BehaviorScript"],"responses":{"200":{"description":"BehaviorScript Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BehaviorScriptGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get behavior script. > Get details of a single behavior script resource from its given \`{behaviorScriptId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorScript","description":"API to manage automation scripts."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BehaviorScriptGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"description":{"type":"string","description":"Description of the behavior script."},"configuration_schema":{"type":"object","description":"JSON schema for configuration."},"trigger_schema":{"type":"object","description":"JSON schema for trigger."},"state_schema":{"type":"object","description":"JSON schema for state."},"version":{"type":"string","description":"Version of the behavior script."},"metadata":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_script/{behaviorScriptId}":{"get":{"operationId":"getBehaviorScript","summary":"Get behavior script.","description":"Get details of a single behavior script resource from its given `{behaviorScriptId}`.","tags":["BehaviorScript"],"parameters":[{"name":"behaviorScriptId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the behavior script"}],"responses":{"200":{"description":"BehaviorScript Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BehaviorScriptGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update behavior script. > Update a single behavior script resource from its given \`{behaviorScriptId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorScript","description":"API to manage automation scripts."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"BehaviorScriptPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `behavior_script` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_script/{behaviorScriptId}":{"put":{"operationId":"updateBehaviorScript","summary":"Update behavior script.","description":"Update a single behavior script resource from its given `{behaviorScriptId}`.","tags":["BehaviorScript"],"parameters":[{"name":"behaviorScriptId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the behavior script"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BehaviorScriptPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Behavior Instance API to manage automation instances. ## List behavior instance. > List all available behavior instance resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorInstance","description":"API to manage automation instances."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BehaviorInstanceGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"script_id":{"type":"string","description":"ID of the behavior script this instance is running."},"enabled":{"type":"boolean","description":"True if the behavior instance is enabled."},"state":{"type":"object","description":"Current state of the behavior instance."},"configuration":{"type":"object","description":"Configuration for this behavior instance."},"dependees":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"status":{"type":"string","enum":["initializing","running","disabled","errored"]},"last_error":{"type":"string","description":"Last error message if status is errored."},"metadata":{"type":"object","properties":{"name":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_instance":{"get":{"operationId":"getBehaviorInstances","summary":"List behavior instance.","description":"List all available behavior instance resources.","tags":["BehaviorInstance"],"responses":{"200":{"description":"BehaviorInstance Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BehaviorInstanceGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get behavior instance. > Get details of a single behavior instance resource from its given \`{behaviorInstanceId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorInstance","description":"API to manage automation instances."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"BehaviorInstanceGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"script_id":{"type":"string","description":"ID of the behavior script this instance is running."},"enabled":{"type":"boolean","description":"True if the behavior instance is enabled."},"state":{"type":"object","description":"Current state of the behavior instance."},"configuration":{"type":"object","description":"Configuration for this behavior instance."},"dependees":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"status":{"type":"string","enum":["initializing","running","disabled","errored"]},"last_error":{"type":"string","description":"Last error message if status is errored."},"metadata":{"type":"object","properties":{"name":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_instance/{behaviorInstanceId}":{"get":{"operationId":"getBehaviorInstance","summary":"Get behavior instance.","description":"Get details of a single behavior instance resource from its given `{behaviorInstanceId}`.","tags":["BehaviorInstance"],"parameters":[{"name":"behaviorInstanceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the behavior instance"}],"responses":{"200":{"description":"BehaviorInstance Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BehaviorInstanceGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update behavior instance. > Update a single behavior instance resource from its given \`{behaviorInstanceId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"BehaviorInstance","description":"API to manage automation instances."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"BehaviorInstancePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `behavior_instance` here)"},"enabled":{"type":"boolean","description":"True to enable the behavior instance."},"configuration":{"type":"object","description":"Configuration for this behavior instance."},"metadata":{"type":"object","properties":{"name":{"type":"string"}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/behavior_instance/{behaviorInstanceId}":{"put":{"operationId":"updateBehaviorInstance","summary":"Update behavior instance.","description":"Update a single behavior instance resource from its given `{behaviorInstanceId}`.","tags":["BehaviorInstance"],"parameters":[{"name":"behaviorInstanceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the behavior instance"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BehaviorInstancePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Geofence Client API to manage geofence clients. ## List geofence client. > List all available geofence client resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GeofenceClient","description":"API to manage geofence clients."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GeofenceClientGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the geofence client."},"is_at_home":{"type":"boolean","description":"True if the client is currently at home."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geofence_client":{"get":{"operationId":"getGeofenceClients","summary":"List geofence client.","description":"List all available geofence client resources.","tags":["GeofenceClient"],"responses":{"200":{"description":"GeofenceClient Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GeofenceClientGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get geofence client. > Get details of a single geofence client resource from its given \`{geofenceClientId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GeofenceClient","description":"API to manage geofence clients."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GeofenceClientGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the geofence client."},"is_at_home":{"type":"boolean","description":"True if the client is currently at home."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geofence_client/{geofenceClientId}":{"get":{"operationId":"getGeofenceClient","summary":"Get geofence client.","description":"Get details of a single geofence client resource from its given `{geofenceClientId}`.","tags":["GeofenceClient"],"parameters":[{"name":"geofenceClientId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the geofence client"}],"responses":{"200":{"description":"GeofenceClient Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GeofenceClientGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update geofence client. > Update a single geofence client resource from its given \`{geofenceClientId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"GeofenceClient","description":"API to manage geofence clients."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GeofenceClientPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `geofence_client` here)"},"name":{"type":"string","description":"Name of the geofence client."},"is_at_home":{"type":"boolean","description":"True if the client is currently at home."}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geofence_client/{geofenceClientId}":{"put":{"operationId":"updateGeofenceClient","summary":"Update geofence client.","description":"Update a single geofence client resource from its given `{geofenceClientId}`.","tags":["GeofenceClient"],"parameters":[{"name":"geofenceClientId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the geofence client"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeofenceClientPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Geolocation API to manage geolocation. ## List geolocation. > List all available geolocation resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Geolocation","description":"API to manage geolocation."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GeolocationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"is_configured":{"type":"boolean","description":"True if geolocation is configured."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geolocation":{"get":{"operationId":"getGeolocations","summary":"List geolocation.","description":"List all available geolocation resources.","tags":["Geolocation"],"responses":{"200":{"description":"Geolocation Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GeolocationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get geolocation. > Get details of a single geolocation resource from its given \`{geolocationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Geolocation","description":"API to manage geolocation."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"GeolocationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"is_configured":{"type":"boolean","description":"True if geolocation is configured."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geolocation/{geolocationId}":{"get":{"operationId":"getGeolocation","summary":"Get geolocation.","description":"Get details of a single geolocation resource from its given `{geolocationId}`.","tags":["Geolocation"],"parameters":[{"name":"geolocationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the geolocation"}],"responses":{"200":{"description":"Geolocation Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GeolocationGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update geolocation. > Update a single geolocation resource from its given \`{geolocationId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Geolocation","description":"API to manage geolocation."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"GeolocationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `geolocation` here)"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/geolocation/{geolocationId}":{"put":{"operationId":"updateGeolocation","summary":"Update geolocation.","description":"Update a single geolocation resource from its given `{geolocationId}`.","tags":["Geolocation"],"parameters":[{"name":"geolocationId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the geolocation"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeolocationPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Device Software Update API to manage device software updates. ## List device software update. > List all available device software update resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"DeviceSoftwareUpdate","description":"API to manage device software updates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DeviceSoftwareUpdateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"state":{"type":"string","enum":["no_update","update_available","ready_to_install","installing","install_failed"],"description":"Current state of the software update."},"problems":{"type":"array","items":{"type":"string"},"description":"Problems preventing update."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device_software_update":{"get":{"operationId":"getDeviceSoftwareUpdates","summary":"List device software update.","description":"List all available device software update resources.","tags":["DeviceSoftwareUpdate"],"responses":{"200":{"description":"DeviceSoftwareUpdate Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceSoftwareUpdateGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get device software update. > Get details of a single device software update resource from its given \`{deviceSoftwareUpdateId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"DeviceSoftwareUpdate","description":"API to manage device software updates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"DeviceSoftwareUpdateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"state":{"type":"string","enum":["no_update","update_available","ready_to_install","installing","install_failed"],"description":"Current state of the software update."},"problems":{"type":"array","items":{"type":"string"},"description":"Problems preventing update."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device_software_update/{deviceSoftwareUpdateId}":{"get":{"operationId":"getDeviceSoftwareUpdate","summary":"Get device software update.","description":"Get details of a single device software update resource from its given `{deviceSoftwareUpdateId}`.","tags":["DeviceSoftwareUpdate"],"parameters":[{"name":"deviceSoftwareUpdateId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device software update"}],"responses":{"200":{"description":"DeviceSoftwareUpdate Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceSoftwareUpdateGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update device software update. > Update a single device software update resource from its given \`{deviceSoftwareUpdateId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"DeviceSoftwareUpdate","description":"API to manage device software updates."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"DeviceSoftwareUpdatePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `device_software_update` here)"},"install":{"type":"object","properties":{"install_state":{"type":"string","enum":["install"],"description":"Set to install to start the update installation."}}}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/device_software_update/{deviceSoftwareUpdateId}":{"put":{"operationId":"updateDeviceSoftwareUpdate","summary":"Update device software update.","description":"Update a single device software update resource from its given `{deviceSoftwareUpdateId}`.","tags":["DeviceSoftwareUpdate"],"parameters":[{"name":"deviceSoftwareUpdateId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device software update"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceSoftwareUpdatePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Service Group API to manage service groups. ## List service group. > List all available service group resources. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ServiceGroup","description":"API to manage service groups."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ServiceGroupGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of services in this group."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/service_group":{"get":{"operationId":"getServiceGroups","summary":"List service group.","description":"List all available service group resources.","tags":["ServiceGroup"],"responses":{"200":{"description":"ServiceGroup Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceGroupGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Get service group. > Get details of a single service group resource from its given \`{serviceGroupId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ServiceGroup","description":"API to manage service groups."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ServiceGroupGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of services in this group."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/service_group/{serviceGroupId}":{"get":{"operationId":"getServiceGroup","summary":"Get service group.","description":"Get details of a single service group resource from its given `{serviceGroupId}`.","tags":["ServiceGroup"],"parameters":[{"name":"serviceGroupId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the service group"}],"responses":{"200":{"description":"ServiceGroup Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceGroupGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` ## Update service group. > Update a single service group resource from its given \`{serviceGroupId}\`. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"ServiceGroup","description":"API to manage service groups."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ServiceGroupPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `service_group` here)"},"services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of services to include in this group."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/service_group/{serviceGroupId}":{"put":{"operationId":"updateServiceGroup","summary":"Update service group.","description":"Update a single service group resource from its given `{serviceGroupId}`.","tags":["ServiceGroup"],"parameters":[{"name":"serviceGroupId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the service group"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceGroupPut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Event API to fetch device events. ## Get Events. > Long poll or stream device event data. ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Event","description":"API to fetch device events."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"Event":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"A UUID that identifies this batch of events."},"type":{"type":"string","enum":["add","delete","error","update"]},"creationtime":{"type":"string","format":"date-time","description":"Time of creation for this batch of events."},"data":{"type":"array","description":"Array of resources affected by this batch of events.","items":{"description":"Individual resource data","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","additionalProperties":true}]}}},"required":["id","creationtime","data","type"]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/eventstream/clip/v2":{"get":{"operationId":"getEventStream","summary":"Get Events.","description":"Long poll or stream device event data.","tags":["Event"],"parameters":[{"name":"If-None-Match","in":"header","required":false,"description":"Unix timestamp of the last seen event, followed by `:0`.\n\nIf any events in the server's buffer have a timestamp greater than this,\nthe server will send them immediately instead of blocking for new events.\nThe server does not maintain a persistent buffer and purges old events\nafter several minutes and does not indicate when the value of\nIf-None-Match falls outside of its buffered window, so clients must poll\nconsistently often else events will be silently missed.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Events Success Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}},"text/event-stream":{"encoding":{"id":{"contentType":"text/plain"},"data":{"contentType":"application/json"}},"schema":{"type":"object","properties":{"id":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}} ``` # Models ## The response object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"response":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"object","properties":{"success":{"type":"object","properties":{"username":{"type":"string"},"clientkey":{"type":"string"}}},"error":{"type":"object","properties":{"type":{"type":"integer"},"address":{"type":"string"},"description":{"type":"string"}}}}}}}}} ``` ## The Error object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}}}}} ``` ## The Resource object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}}}}} ``` ## The ResourceIdentifier object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ResourceOwned object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ResourceGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ResourceGet":{"type":"object","description":"The API is actually returning the full resource description depending on the type, not just the fields that are\ndocumented below.\n","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ApiResponse object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}}}}} ``` ## The ProductArchetype object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]}}}} ``` ## The ProductData object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]}}}} ``` ## The DeviceGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DeviceGet":{"type":"object","description":"Definition of a device resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["product_data","metadata","identify","services"],"properties":{"type":{"type":"string","enum":["device"]},"product_data":{"$ref":"#/components/schemas/ProductData"},"metadata":{"type":"object","required":["name","archetype"],"properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","description":"Triggers a visual identification sequence on the device"},"usertest":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode.\nIn usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)\n"}}},"services":{"type":"array","description":"References all services providing control and state of the device.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]}}}} ``` ## The DevicePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DevicePut":{"type":"object","properties":{"type":{"type":"string","enum":["device"]},"metadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","properties":{"action":{"type":"string","description":"Triggers a visual identification sequence, current implemented as (which can change in the future):\nBridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors\nperform LED identification cycles for 15 seconds\n","enum":["identify"]}}},"usertest":{"type":"object","properties":{"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate\nstate changes on device LED (if applicable)\n"}}}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]}}}} ``` ## The DevicePowerGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DevicePowerGet":{"type":"object","description":"Definition of a device power resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["power_state"],"properties":{"power_state":{"type":"object","properties":{"battery_state":{"type":"string","enum":["normal","low","critical"],"description":"Status of the power source of a device, only for battery powered devices.\n\n- `normal` – battery level is sufficient\n- `low` – battery level low, some features (e.g. software update) might stop working, please change battery soon\n- `critical` – battery level critical, device can fail any moment\n"},"battery_level":{"type":"integer","minimum":0,"maximum":100,"description":"The current battery state in percent, only for battery powered devices."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The LightArchetype object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightArchetype":{"type":"string","description":"Light archetype","enum":["unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]}}}} ``` ## The On object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}}}}} ``` ## The Brightness object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"}}}} ``` ## The GamutPosition object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}}}}} ``` ## The SupportedDynamicStatus object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SupportedDynamicStatus":{"type":"string","description":"Current status of the lamp with dynamics.","enum":["dynamic_palette","none"]}}}} ``` ## The SupportedSignals object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]}}}} ``` ## The Color object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}}}}} ``` ## The SupportedGradientMode object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]}}}} ``` ## The Gradient object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]}}}} ``` ## The SupportedEffects object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]}}}} ``` ## The Mirek object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"}}}} ``` ## The EffectsV2Parameters object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"}}}} ``` ## The EffectsV2 object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"}}}} ``` ## The SupportedTimedEffects object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]}}}} ``` ## The Dimming object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"}}}} ``` ## The LightGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["metadata","identify","service_id","on","mode"],"properties":{"metadata":{"type":"object","description":"Deprecated, use metadata on device level","required":["name","archetype","function"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/LightArchetype"},"function":{"type":"string","description":"Function of the light service","enum":["functional","decorative","mixed","unknown"]},"fixed_mired":{"type":"integer","minimum":153,"maximum":500,"description":"A fixed mired value of the white lamp"}}},"identify":{"type":"object","description":"Triggers identification sequence on the light"},"service_id":{"type":"integer","minimum":0,"description":"Service identification number. 0 indicates service of a single instance"},"on":{"$ref":"#/components/schemas/On"},"dimming":{"type":"object","properties":{"brightness":{"$ref":"#/components/schemas/Brightness"},"min_dim_level":{"type":"number","minimum":0,"maximum":100,"description":"Percentage of the maximum lumen the device outputs on minimum brightness"}}},"color_temperature":{"type":"object","properties":{"mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"mirek_valid":{"type":"boolean","description":"Indication whether the value presented in mirek is valid"},"mirek_schema":{"type":"object","properties":{"mirek_minimum":{"type":"integer","minimum":153,"maximum":500,"description":"minimum color temperature this light supports"},"mirek_maximum":{"type":"integer","minimum":153,"maximum":500,"description":"maximum color temperature this light supports"}}}}},"color":{"type":"object","properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"},"gamut":{"type":"object","description":"Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.","properties":{"red":{"$ref":"#/components/schemas/GamutPosition"},"green":{"$ref":"#/components/schemas/GamutPosition"},"blue":{"$ref":"#/components/schemas/GamutPosition"}}},"gamut_type":{"type":"string","description":"The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut","enum":["A","B","C","other"]}}},"dynamics":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SupportedDynamicStatus"},"status_values":{"type":"array","description":"Statuses in which a lamp could be when playing dynamics.","items":{"$ref":"#/components/schemas/SupportedDynamicStatus"}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid"},"speed_valid":{"type":"boolean","description":"Indicates whether the value presented in speed is valid"}}},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","description":"Supported alert actions for this light.","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing signaling properties.","properties":{"signal_values":{"type":"array","items":{"$ref":"#/components/schemas/SupportedSignals"}},"estimated_end":{"type":"integer","description":"Timestamp indicating when the active signal is expected to end. Value is not set if there is no_signal"},"colors":{"type":"array","description":"Colors that were provided for the active effect.","items":{"$ref":"#/components/schemas/Color"}}}},"mode":{"type":"string","enum":["normal","streaming"]},"gradient":{"type":"object","allOf":[{"$ref":"#/components/schemas/Gradient"},{"type":"object","properties":{"points_capable":{"type":"integer","description":"Number of color points that gradient lamp is capable of showing with gradience."},"mode_values":{"type":"array","description":"Modes a gradient device can deploy the gradient palette of colors","items":{"$ref":"#/components/schemas/SupportedGradientMode"}},"pixel_count":{"type":"integer","description":"Number of pixels in the device"}}}]},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"status":{"$ref":"#/components/schemas/SupportedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"effect":{"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"type":"array","description":"Possible status values in which a light could be when playing an effect.","items":{"$ref":"#/components/schemas/SupportedEffects"}}}},"effects_v2":{"$ref":"#/components/schemas/EffectsV2"},"timed_effects":{"type":"object","description":"Basic feature containing timed effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedTimedEffects"},"effect_values":{"type":"array","description":"Possible timed effect values you can set in a light","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"status":{"$ref":"#/components/schemas/SupportedTimedEffects"},"status_values":{"type":"array","description":"Possible status values in which a light could be when playing a timed effect.","items":{"$ref":"#/components/schemas/SupportedTimedEffects"}},"duration":{"type":"integer","description":"Duration is mandatory when timed effect is set except for no_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms."}}},"powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}},"product_data":{"type":"object","description":"Product data about the light.","properties":{"function":{"type":"string","description":"Function of the light source.","enum":["functional","decorative","mixed","unknown"]}}},"geometry":{"type":"object","description":"Geometry information for pixel-addressable lights such as gradient strips.","properties":{"pixel_positions":{"type":"array","description":"Ordered list of pixel positions for this light. Empty for non-gradient lights.","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"LightArchetype":{"type":"string","description":"Light archetype","enum":["unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"SupportedDynamicStatus":{"type":"string","description":"Current status of the lamp with dynamics.","enum":["dynamic_palette","none"]},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}}}}} ``` ## The DimmingDelta object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}}}}} ``` ## The ColorTemperature object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"}}}} ``` ## The ColorTemperatureDelta object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}}}}} ``` ## The LightDynamics object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightDynamics":{"type":"object","properties":{"duration":{"type":"integer","description":"Duration of a light transition or timed effects in ms."},"speed":{"type":"number","minimum":0,"maximum":0,"description":"Speed of dynamic palette or effect.\nThe speed is valid for the dynamic palette if the status is `dynamic_palette` or for the corresponding effect listed in status.\nIn case of status `none`, the speed is not valid.\n"}}}}}} ``` ## The Alert object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}}}}} ``` ## The Signaling object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}}}}} ``` ## The Effects object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]}}}} ``` ## The Powerup object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Brightness"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}}}}} ``` ## The LightPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `light` here)"},"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"dimming_delta":{"$ref":"#/components/schemas/DimmingDelta"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"color_temperature_delta":{"$ref":"#/components/schemas/ColorTemperatureDelta"},"color":{"$ref":"#/components/schemas/Color"},"dynamics":{"$ref":"#/components/schemas/LightDynamics"},"alert":{"$ref":"#/components/schemas/Alert"},"signaling":{"$ref":"#/components/schemas/Signaling"},"mode":{"type":"string","enum":["normal","streaming"]},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"$ref":"#/components/schemas/Effects"},"effects_v2":{"$ref":"#/components/schemas/EffectsV2"},"timed_effects":{"type":"object","description":"Basic feature containing timed effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedTimedEffects"},"duration":{"type":"integer","description":"Duration is mandatory when timed effect is set except for no_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms."}}},"powerup":{"$ref":"#/components/schemas/Powerup"}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"LightDynamics":{"type":"object","properties":{"duration":{"type":"integer","description":"Duration of a light transition or timed effects in ms."},"speed":{"type":"number","minimum":0,"maximum":0,"description":"Speed of dynamic palette or effect.\nThe speed is valid for the dynamic palette if the status is `dynamic_palette` or for the corresponding effect listed in status.\nIn case of status `none`, the speed is not valid.\n"}}},"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}},"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"Effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"EffectsV2":{"type":"object","description":"Extended effect control with support for custom color, color temperature, and speed parameters.\nThis property is present on lights that support the newer effects engine and allows fine-grained\ncontrol over effect appearance beyond what the basic `effects` property provides.\n","properties":{"action":{"type":"object","writeOnly":true,"description":"Set effect with optional parameters.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}},"status":{"type":"object","readOnly":true,"description":"Current effect status and active parameters.","properties":{"effect":{"readOnly":true,"$ref":"#/components/schemas/SupportedEffects"},"effect_values":{"readOnly":true,"type":"array","description":"Possible effect values supported by this light.","items":{"$ref":"#/components/schemas/SupportedEffects"}},"parameters":{"$ref":"#/components/schemas/EffectsV2Parameters"}}}}},"EffectsV2Parameters":{"type":"object","description":"Parameters for controlling the appearance of an active effect.","properties":{"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"mirek_valid":{"type":"boolean","readOnly":true,"description":"Indication whether the mirek value is valid for this effect"}}},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of the effect animation. 0.0 is slowest, 1.0 is fastest."}}},"SupportedTimedEffects":{"type":"string","description":"Current status values the light is in regarding timed effects","enum":["sunrise","sunset","no_effect"]},"Powerup":{"type":"object","description":"Feature containing properties to configure powerup behaviour of a lightsource.","properties":{"preset":{"type":"string","description":"When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.","enum":["safety","powerfail","last_on_state","custom"]},"configured":{"type":"boolean","description":"Indicates if the shown values have been configured in the lightsource."},"on":{"type":"object","properties":{"mode":{"type":"string","description":"State to activate after powerup.\nOn will use the value specified in the “on” property.\nWhen setting mode “on”, the on property must be included.\nToggle will alternate between on and off on each subsequent power toggle.\nPrevious will return to the state it was in before powering off.\n","enum":["on","toggle","previous"]},"on":{"$ref":"#/components/schemas/On"}}},"dimming":{"type":"object","properties":{"mode":{"type":"string","description":"Dimming will set the brightness to the specified value after power up.\nWhen setting mode “dimming”, the dimming property must be included.\nPrevious will set brightness to the state it was in before powering off.\n","enum":["dimming","previous"]},"dimming":{"$ref":"#/components/schemas/Brightness"},"color":{"type":"object","properties":{"mode":{"type":"string","enum":["color_temperature","color","previous"],"description":"State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off."},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"},"color":{"$ref":"#/components/schemas/Color"}}}}}}}}}}}} ``` ## The LightLevelGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","light"],"properties":{"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"},"light":{"type":"object","required":["light_level","light_level_valid"],"properties":{"light_level":{"type":"integer","description":"Deprecated. Moved to light_level_report/light_level"},"light_level_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in light_level is valid"},"light_level_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"light_level":{"type":"integer","description":"Light level in 10000*log10(lux) +1 measured by sensor.\nLogarithmic scale used because the human eye adjusts to light levels and small changes at low\nlux levels are more noticeable than at high lux levels.\nThis allows use of linear scale configuration sliders.\n"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The LightLevelPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"LightLevelPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `light_level` here)"},"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"}}}}}} ``` ## The MotionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","motion"],"properties":{"enabled":{"type":"boolean","description":"true when the sensor is activated, false when deactivated"},"motion":{"type":"object","required":["motion","motion_valid"],"properties":{"motion":{"type":"boolean","description":"Deprecated. Moved to motion_report/motion."},"motion_valid":{"type":"boolean","description":"Deprecated. Motion is valid when motion_report property is present, invalid when absent."},"motion_report":{"type":"object","properties":{"changed":{"type":"string","description":"last time the value of this property is changed"},"motion":{"type":"boolean","description":"true if motion is detected"}}}}},"sensitivity":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"sensitivity":{"type":"integer","description":"Sensitivity of the sensor. Value in the range 0 to sensitivity_max"},"sensitivity_max":{"type":"integer","description":"Maximum value of the sensitivity configuration attribute."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The MotionPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion` here)"},"enabled":{"type":"boolean","description":"true when the sensor is activated, false when deactivated"},"sensitivity":{"type":"object","properties":{"sensitivity":{"type":"integer","description":"Sensitivity of the sensor. Value in the range 0 to sensitivity_max."}}}}}}}} ``` ## The GroupedLightGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedLightGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"on":{"description":"Joined on control & aggregated on state. “on” is true if any light in the group is on.","$ref":"#/components/schemas/On"},"dimming":{"description":"Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.","$ref":"#/components/schemas/Dimming"},"alert":{"type":"object","description":"Joined alert control","properties":{"action_values":{"type":"array","items":{"type":"string"}}}},"signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal_values":{"type":"array","description":"Signals that the light supports.","items":{"$ref":"#/components/schemas/SupportedSignals"}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"SupportedSignals":{"type":"string","description":"Indicates which signal is currently active.","enum":["no_signal","on_off","on_off_color","alternating"]}}}} ``` ## The Dynamics object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}}}}} ``` ## The GroupedLightPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedLightPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_light` here)","enum":["grouped_light"]},"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"dimming_delta":{"$ref":"#/components/schemas/DimmingDelta"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"color_temperature_delta":{"$ref":"#/components/schemas/ColorTemperatureDelta"},"color":{"$ref":"#/components/schemas/Color"},"alert":{"$ref":"#/components/schemas/Alert"},"signaling":{"$ref":"#/components/schemas/Signaling"},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"DimmingDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"brightness_delta":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.\n"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"ColorTemperatureDelta":{"type":"object","properties":{"action":{"type":"string","enum":["up","down","stop"]},"mirek_delta":{"type":"integer","minimum":0,"maximum":347,"description":"Mirek delta to current mirek. Clip at mirek_minimum and mirek_maximum of mirek_schema."}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Alert":{"type":"object","description":"Joined alert control","properties":{"action":{"type":"string"}}},"Signaling":{"type":"object","description":"Feature containing basic signaling properties.","properties":{"signal":{"type":"string","description":"- `no_signal`: No signal is active. Write “no_signal” to stop active signal.\n- `on_off`: Toggles between max brightness and Off in fixed color.\n- `on_off_color`: Toggles between off and max brightness with color provided.\n- `alternating`: Alternates between 2 provided colors.\n","enum":["no_signal","on_off","on_off_color","alternating"]},"duration":{"type":"integer","minimum":0,"maximum":65534000,"description":"Duration has a max of 65534000 ms and a stepsize of 1 second.\nValues inbetween steps will be rounded.\nDuration is ignored for `no_signal`.\n"},"color":{"type":"array","minItems":1,"maxItems":2,"description":"List of colors to apply to the signal (not supported by all signals)","items":{"$ref":"#/components/schemas/Color"}}}},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}}}}} ``` ## The BridgeGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BridgeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["bridge_id","time_zone"],"properties":{"type":{"type":"string","enum":["bridge"]},"bridge_id":{"type":"string","description":"Unique identifier of the bridge as printed on the device. Lower case."},"time_zone":{"type":"object","required":["time_zone"],"properties":{"time_zone":{"type":"string","description":"Time zone where the user's home is located (as Olson ID)."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The BridgePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BridgePut":{"type":"object","properties":{"type":{"type":"string","enum":["bridge"]}}}}}} ``` ## The BridgeHomeGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BridgeHomeGet":{"type":"object","description":"Definition of a bridge resource","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services"],"properties":{"type":{"type":"string","enum":["bridge_home"]},"children":{"type":"array","description":"Child devices/services to group by the derived group.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition\nof grouped type Supported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ActionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]}}}} ``` ## The SceneMetadata object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ColorPaletteGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"}}}} ``` ## The ColorTemperaturePalettePost object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"}}}} ``` ## The ScenePalette object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]}}}} ``` ## The SceneGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["actions","metadata","group","speed","auto_dynamic","status"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionGet"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"},"status":{"type":"object","properties":{"active":{"type":"string","enum":["inactive","static","dynamic_palette"]}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}}}}} ``` ## The ActionPost object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}}}}} ``` ## The ScenePost object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ScenePost":{"type":"object","required":["actions","metadata","group"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}}}}} ``` ## The SceneRecall object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"When writing active, the actions in the scene are executed on the target. dynamic_palette starts dynamic scene with colors in the Palette object.","enum":["active","dynamic_palette","static"]},"duration":{"type":"integer","description":"Transition to the scene within the timeframe given by duration"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"}}}} ``` ## The ScenePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ScenePut":{"type":"object","properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"recall":{"$ref":"#/components/schemas/SceneRecall"},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"When writing active, the actions in the scene are executed on the target. dynamic_palette starts dynamic scene with colors in the Palette object.","enum":["active","dynamic_palette","static"]},"duration":{"type":"integer","description":"Transition to the scene within the timeframe given by duration"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}}}}} ``` ## The SmartSceneMetadata object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}}}}} ``` ## The SmartSceneMetadataWithImage object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The SmartSceneTimeslotGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The Weekday object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}}}} ``` ## The DayTimeslotsGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}}}} ``` ## The SmartSceneGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadataWithImage"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"active_timeslot":{"description":"the active time slot in execution","type":"object","properties":{"timeslot_id":{"type":"integer"},"weekday":{"$ref":"#/components/schemas/Weekday"}},"required":["timeslot_id","weekday"]},"state":{"description":"the current state of the smart scene. The default state is inactive if no recall is provided","type":"string","enum":["active","inactive"]}},"required":["metadata","group","week_timeslots","transition_duration","state"]}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}}}} ``` ## The SmartSceneRecall object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}},"required":["action"]}}}} ``` ## The SmartScenePost object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartScenePost":{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadataWithImage"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"recall":{"$ref":"#/components/schemas/SmartSceneRecall"}},"required":["metadata","group","week_timeslots"]},"SmartSceneMetadataWithImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/SmartSceneMetadata"},{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"SmartSceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}},"required":["action"]}}}} ``` ## The SmartSceneOptionalRecall object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartSceneOptionalRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}}}}}} ``` ## The SmartScenePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SmartScenePut":{"type":"object","properties":{"type":{"type":"string","enum":["smart_scene"]},"metadata":{"$ref":"#/components/schemas/SmartSceneMetadata"},"week_timeslots":{"description":"information on what is the light state for every timeslot of the day","type":"array","items":{"$ref":"#/components/schemas/DayTimeslotsGet"}},"transition_duration":{"description":"duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)","type":"integer"},"recall":{"$ref":"#/components/schemas/SmartSceneOptionalRecall"}}},"SmartSceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"DayTimeslotsGet":{"type":"object","properties":{"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/SmartSceneTimeslotGet"}},"recurrence":{"type":"array","items":{"$ref":"#/components/schemas/Weekday"}}},"required":["timeslots","recurrence"]},"SmartSceneTimeslotGet":{"type":"object","properties":{"start_time":{"type":"object","properties":{"kind":{"type":"string","enum":["time","sunset"]},"time":{"type":"object","description":"this property is only used when property “kind” is “time”","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59}}}},"required":["kind"]},"target":{"$ref":"#/components/schemas/ResourceIdentifier"}},"required":["start_time","target"]},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"Weekday":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"SmartSceneOptionalRecall":{"type":"object","properties":{"action":{"type":"string","description":"Activate will start the smart (24h) scene; deactivate will stop it","enum":["activate","deactivate"]}}}}}} ``` ## The RoomArchetype object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]}}}} ``` ## The RoomGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"RoomGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["children","services","metadata"],"properties":{"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"services":{"type":"array","description":"References all services aggregating control and state of children in the group.\nThis includes all services grouped in the group hierarchy given by child relation.\nThis includes all services of a device grouped in the group hierarchy given by child relation.\nAggregation is per service type, ie every service type which can be grouped has a corresponding definition of\ngrouped type.\nSupported types: – grouped_light\n","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","required":["name","archetype"],"properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]}}}} ``` ## The RoomPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"RoomPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `room` here)"},"children":{"type":"array","description":"Child devices/services to group by the derived group","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"metadata":{"type":"object","description":"configuration object for a room","properties":{"name":{"type":"string","description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/RoomArchetype"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"RoomArchetype":{"type":"string","description":"Possible archetypes of a room","enum":["living_room","kitchen","dining","bedroom","kids_bedroom","bathroom","nursery","recreation","office","gym","hallway","toilet","front_door","garage","terrace","garden","driveway","carport","home","downstairs","upstairs","top_floor","attic","guest_room","staircase","lounge","man_cave","computer","studio","music","tv","reading","closet","storage","laundry_room","balcony","porch","barbecue","pool","other"]}}}} ``` ## The TemperatureGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"TemperatureGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["enabled","temperature"],"properties":{"enabled":{"type":"boolean","description":"`true` when sensor is activated, `false` when deactivated\n"},"temperature":{"type":"object","required":["temperature","temperature_valid"],"properties":{"temperature":{"type":"number","description":"Deprecated. Moved to Temperature_report/temperature"},"temperature_valid":{"type":"boolean","description":"Deprecated. Indication whether the value presented in temperature is valid"},"temperature_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"last time the value of this property is changed."},"temperature":{"type":"number","description":"Temperature in 1.00 degrees Celsius"}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The TemperaturePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"TemperaturePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `temperature` here)","enum":["temperature"]},"enabled":{"type":"boolean","description":"true when sensor is activated, false when deactivated"}}}}}} ``` ## The ButtonGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"button":{"type":"object","properties":{"button_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"The button event that was triggered."}}},"last_event":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"],"description":"Deprecated. Use button_report instead."},"repeat_interval":{"type":"integer","description":"Interval in milliseconds for repeat events."},"event_values":{"type":"array","items":{"type":"string","enum":["initial_press","repeat","short_release","long_release","double_short_release","long_press"]},"description":"List of supported button events."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ButtonPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ButtonPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `button` here)"},"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"button":{"type":"object","properties":{"repeat_interval":{"type":"integer","description":"Interval in milliseconds for repeat events."}}}}}}}} ``` ## The BellButtonGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BellButtonGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"bell":{"type":"object","properties":{"bell_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"event":{"type":"string","enum":["ring"],"description":"The bell button event that was triggered."}}},"last_event":{"type":"string","enum":["ring"],"description":"Deprecated. Use bell_report instead."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The BellButtonPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BellButtonPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `bell_button` here)"}}}}}} ``` ## The RelativeRotaryGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"RelativeRotaryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"control_id":{"type":"integer","description":"Control identifier of the switch, unique within the device."}}},"relative_rotary":{"type":"object","properties":{"rotary_report":{"type":"object","properties":{"updated":{"type":"string","format":"date-time","description":"Last time the value of this property was updated."},"action":{"type":"string","enum":["start","repeat"],"description":"Type of rotary event."},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"],"description":"Direction of rotation."},"steps":{"type":"integer","description":"Amount of rotation since last event in case of repeat."},"duration":{"type":"integer","description":"Duration of rotation since last event in milliseconds."}}}}},"last_event":{"type":"object","description":"Deprecated. Use rotary_report instead.","properties":{"action":{"type":"string","enum":["start","repeat"]},"rotation":{"type":"object","properties":{"direction":{"type":"string","enum":["clock_wise","counter_clock_wise"]},"steps":{"type":"integer"},"duration":{"type":"integer"}}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The RelativeRotaryPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"RelativeRotaryPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `relative_rotary` here)"}}}}}} ``` ## The ContactGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ContactGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"contact_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"state":{"type":"string","enum":["contact","no_contact"],"description":"State of the contact sensor."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ContactPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ContactPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `contact` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}}}}} ``` ## The TamperGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"TamperGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"tamper_reports":{"type":"array","items":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"source":{"type":"string","description":"Source of the tamper event."},"state":{"type":"string","enum":["tampered","not_tampered"],"description":"State of the tamper sensor."}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The TamperPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"TamperPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `tamper` here)"}}}}}} ``` ## The CameraMotionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"CameraMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion_report":{"type":"object","properties":{"changed":{"type":"string","format":"date-time","description":"Last time the value of this property was changed."},"motion":{"type":"boolean","description":"True if motion is detected."}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The CameraMotionPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"CameraMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `camera_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}}}}} ``` ## The GroupedMotionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected in any of the grouped sensors."},"motion_valid":{"type":"boolean","description":"True if any of the grouped motion sensors are reporting valid motion."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The GroupedMotionPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_motion` here)"}}}}}} ``` ## The GroupedLightLevelGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedLightLevelGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"light":{"type":"object","properties":{"light_level":{"type":"integer","description":"Light level in 10000*log10(lux)+1 measured by sensor."},"light_level_valid":{"type":"boolean","description":"True if light level is valid."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The GroupedLightLevelPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GroupedLightLevelPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `grouped_light_level` here)"}}}}}} ``` ## The ConvenienceAreaMotionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ConvenienceAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ConvenienceAreaMotionPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ConvenienceAreaMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `convenience_area_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}}}}} ``` ## The SecurityAreaMotionGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SecurityAreaMotionGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."},"motion":{"type":"object","properties":{"motion":{"type":"boolean","description":"True if motion is detected."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The SecurityAreaMotionPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SecurityAreaMotionPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `security_area_motion` here)"},"enabled":{"type":"boolean","description":"True when sensor is activated, false when deactivated."}}}}}} ``` ## The MotionAreaCandidateGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionAreaCandidateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensor resources that are candidates for this area."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The MotionAreaCandidatePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionAreaCandidatePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion_area_candidate` here)"}}}}}} ``` ## The MotionAreaConfigurationGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionAreaConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"enabled":{"type":"boolean","description":"True when configuration is active."},"motion_sensors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of motion sensors in this area configuration."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The MotionAreaConfigurationPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MotionAreaConfigurationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `motion_area_configuration` here)"},"enabled":{"type":"boolean","description":"True when configuration is active."}}}}}} ``` ## The ZigbeeConnectivityGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZigbeeConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue","unidirectional_incoming"],"description":"Current connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"channel":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"value":{"type":"string","enum":["channel_11","channel_15","channel_20","channel_25"],"description":"Current zigbee channel."}}},"extended_pan_id":{"type":"string","description":"Extended PAN ID of the zigbee network."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ZigbeeConnectivityPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZigbeeConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zigbee_connectivity` here)"},"channel":{"type":"object","properties":{"value":{"type":"string","enum":["channel_11","channel_15","channel_20","channel_25"],"description":"Zigbee channel to set."}}}}}}}} ``` ## The ZgpConnectivityGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZgpConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current connectivity status of the device."},"source_id":{"type":"string","description":"Source ID of the ZGP device."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ZgpConnectivityPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZgpConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zgp_connectivity` here)"}}}}}} ``` ## The WifiConnectivityGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"WifiConnectivityGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","connectivity_issue"],"description":"Current WiFi connectivity status of the device."},"mac_address":{"type":"string","description":"MAC address of the device."},"signal_strength":{"type":"object","properties":{"status":{"type":"string","enum":["good","fair","bad"]},"value":{"type":"integer","description":"Signal strength in dBm."}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The WifiConnectivityPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"WifiConnectivityPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `wifi_connectivity` here)"}}}}}} ``` ## The ZigbeeDeviceDiscoveryGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZigbeeDeviceDiscoveryGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["active","ready"],"description":"Current status of the device discovery."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ZigbeeDeviceDiscoveryPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ZigbeeDeviceDiscoveryPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `zigbee_device_discovery` here)"},"action":{"type":"object","properties":{"action_type":{"type":"string","enum":["search"],"description":"Action to trigger device discovery."}}}}}}}} ``` ## The HomekitGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"HomekitGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","pairing","unpaired"],"description":"Current HomeKit pairing status."},"action":{"type":"string","enum":["none"],"description":"Current HomeKit action."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The HomekitPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"HomekitPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `homekit` here)"},"action":{"type":"string","enum":["homekit_reset"],"description":"Action to trigger on the HomeKit integration."}}}}}} ``` ## The MatterGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MatterGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"has_qr_code":{"type":"boolean","description":"Indicates if QR code for Matter commissioning is available."},"max_fabrics":{"type":"integer","description":"Maximum number of fabrics that can be added."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The MatterPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MatterPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `matter` here)"},"action":{"type":"object","properties":{"action_type":{"type":"string","enum":["matter_reset"],"description":"Action to trigger on the Matter integration."}}}}}}}} ``` ## The MatterFabricGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MatterFabricGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"status":{"type":"string","enum":["paired","timedout"],"description":"Current Matter fabric status."},"fabric_data":{"type":"object","properties":{"label":{"type":"string","description":"Label of the fabric."},"vendor_id":{"type":"integer","description":"Vendor ID of the commissioning controller."}}},"creation_time":{"type":"string","format":"date-time","description":"Timestamp when the fabric was created."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The MatterFabricPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"MatterFabricPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `matter_fabric` here)"}}}}}} ``` ## The EntertainmentGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EntertainmentGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"renderer":{"type":"boolean","description":"Indicates if the device can be used for entertainment streaming."},"proxy":{"type":"boolean","description":"Indicates if the device is acting as entertainment proxy."},"max_streams":{"type":"integer","description":"Maximum number of streams this device supports."},"segments":{"type":"object","properties":{"configurable":{"type":"boolean"},"max_segments":{"type":"integer"},"segments":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer"},"length":{"type":"integer"}}}}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The EntertainmentPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EntertainmentPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `entertainment` here)"}}}}}} ``` ## The EntertainmentConfigurationGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EntertainmentConfigurationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"name":{"type":"string","description":"Human readable name of the configuration."}}},"configuration_type":{"type":"string","enum":["screen","monitor","music","3dspace","other"],"description":"Type of entertainment configuration."},"status":{"type":"string","enum":["active","inactive"],"description":"Status of the entertainment configuration."},"stream_proxy":{"type":"object","properties":{"mode":{"type":"string","enum":["auto","manual"]},"node":{"$ref":"#/components/schemas/ResourceIdentifier"}}},"channels":{"type":"array","items":{"type":"object","properties":{"channel_id":{"type":"integer"},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}},"members":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"index":{"type":"integer"}}}}}}},"locations":{"type":"object","properties":{"service_locations":{"type":"array","items":{"type":"object","properties":{"service":{"$ref":"#/components/schemas/ResourceIdentifier"},"positions":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"}}}}}}}}},"light_services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The EntertainmentConfigurationPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"EntertainmentConfigurationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `entertainment_configuration` here)"},"metadata":{"type":"object","properties":{"name":{"type":"string","description":"Human readable name of the configuration."}}},"configuration_type":{"type":"string","enum":["screen","monitor","music","3dspace","other"]},"action":{"type":"string","enum":["start","stop"],"description":"Start or stop streaming."}}}}}} ``` ## The SpeakerGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SpeakerGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"string","enum":["soundloop"]},"description":"Supported speaker alerts."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The SpeakerPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"SpeakerPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `speaker` here)"}}}}}} ``` ## The BehaviorScriptGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BehaviorScriptGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"description":{"type":"string","description":"Description of the behavior script."},"configuration_schema":{"type":"object","description":"JSON schema for configuration."},"trigger_schema":{"type":"object","description":"JSON schema for trigger."},"state_schema":{"type":"object","description":"JSON schema for state."},"version":{"type":"string","description":"Version of the behavior script."},"metadata":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}}}}} ``` ## The BehaviorScriptPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BehaviorScriptPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `behavior_script` here)"}}}}}} ``` ## The BehaviorInstanceGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BehaviorInstanceGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"script_id":{"type":"string","description":"ID of the behavior script this instance is running."},"enabled":{"type":"boolean","description":"True if the behavior instance is enabled."},"state":{"type":"object","description":"Current state of the behavior instance."},"configuration":{"type":"object","description":"Configuration for this behavior instance."},"dependees":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}},"status":{"type":"string","enum":["initializing","running","disabled","errored"]},"last_error":{"type":"string","description":"Last error message if status is errored."},"metadata":{"type":"object","properties":{"name":{"type":"string"}}}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The BehaviorInstancePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"BehaviorInstancePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `behavior_instance` here)"},"enabled":{"type":"boolean","description":"True to enable the behavior instance."},"configuration":{"type":"object","description":"Configuration for this behavior instance."},"metadata":{"type":"object","properties":{"name":{"type":"string"}}}}}}}} ``` ## The GeofenceClientGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GeofenceClientGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"name":{"type":"string","description":"Name of the geofence client."},"is_at_home":{"type":"boolean","description":"True if the client is currently at home."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}}}}} ``` ## The GeofenceClientPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GeofenceClientPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `geofence_client` here)"},"name":{"type":"string","description":"Name of the geofence client."},"is_at_home":{"type":"boolean","description":"True if the client is currently at home."}}}}}} ``` ## The GeolocationGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GeolocationGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"is_configured":{"type":"boolean","description":"True if geolocation is configured."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}}}}} ``` ## The GeolocationPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"GeolocationPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `geolocation` here)"}}}}}} ``` ## The DeviceSoftwareUpdateGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DeviceSoftwareUpdateGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","properties":{"state":{"type":"string","enum":["no_update","update_available","ready_to_install","installing","install_failed"],"description":"Current state of the software update."},"problems":{"type":"array","items":{"type":"string"},"description":"Problems preventing update."}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The DeviceSoftwareUpdatePut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"DeviceSoftwareUpdatePut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `device_software_update` here)"},"install":{"type":"object","properties":{"install_state":{"type":"string","enum":["install"],"description":"Set to install to start the update installation."}}}}}}}} ``` ## The ServiceGroupGet object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ServiceGroupGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of services in this group."}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The ServiceGroupPut object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"ServiceGroupPut":{"type":"object","properties":{"type":{"type":"string","description":"Type of the supported resources (always `service_group` here)"},"services":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"},"description":"List of services to include in this group."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}}}}} ``` ## The Event object ```json {"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"components":{"schemas":{"Event":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"A UUID that identifies this batch of events."},"type":{"type":"string","enum":["add","delete","error","update"]},"creationtime":{"type":"string","format":"date-time","description":"Time of creation for this batch of events."},"data":{"type":"array","description":"Array of resources affected by this batch of events.","items":{"description":"Individual resource data","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","additionalProperties":true}]}}},"required":["id","creationtime","data","type"]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}}}}} ``` # OpenHue CLI OpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems. Welcome to the OpenHue CLI documentation portal, your go-to resource for understanding and using the OpenHue Command-Line Interface. This powerful tool is designed to make interacting with your Philips Hue smart lighting system a breeze. Below, we'll introduce OpenHue CLI and highlight its key features, platform support, and installation methods. ## About OpenHue CLI OpenHue CLI is a command-line interface that simplifies your interaction with Philips Hue smart lighting systems. It empowers you to control your Philips Hue lights and execute various tasks directly from your command line. Whether you're a seasoned developer or a casual user, OpenHue CLI offers an efficient and flexible way to manage your lighting environment. ## Key Features * **Discover and Connect**: OpenHue CLI allows you to effortlessly discover and connect to Philips Hue bridges. Say goodbye to complex setup procedures and get straight to controlling your lights. * **Light Management**: Explore your lighting ecosystem with ease. You can list available lights and check their current status, giving you complete control over your smart bulbs. * **Light Control**: Turn your lights on or off, adjust brightness, and fine-tune colors, all with simple commands. OpenHue CLI makes it straightforward to create the lighting atmosphere you desire. * And even more coming soon... ## Platform Support OpenHue CLI caters to a wide range of users, with support for the following operating systems: * **macOS** * **Linux** * **Windows** No matter your preferred platform, OpenHue CLI is here to streamline your interaction with Philips Hue smart lighting systems. ## **Installation Methods** Installing OpenHue CLI is easy and can be done using two methods: [**Homebrew**](https://brew.sh/) and [**Docker**](https://www.docker.com/). To get started, visit the [Installation](/cli/installation) page for detailed instructions. Whether you're a developer looking to integrate Philips Hue lighting into your projects or a smart home enthusiast seeking to enhance your lighting experience, OpenHue CLI is the tool you need. Explore our comprehensive documentation to make the most of this powerful command-line interface. Feel free to dive into our detailed guides and examples to unlock the full potential of OpenHue CLI. If you have any questions or need assistance, our support resources are just a click away. Thank you for choosing OpenHue CLI, and welcome to a brighter, more convenient way of controlling your Philips Hue lights. # Installation The OpenHue CLI is available for macOS, Linux and Windows and can be installed via different package managers or even with Docker. ## Homebrew To install the OpenHue CLI via [Homebrew](https://brew.sh/), you first need to add the tap the formula repository: ```bash brew tap openhue/cli ``` {% hint style="info" %} You won't need to type this command again {% endhint %} Once you have tapped the repository, you can now install the `openhue-cli` executable: ```bash brew install openhue-cli ``` And that's it you can now use OpenHue CLI: ```bash openhue help ``` When a new version of OpenHue CLI has been released, simply run the following commands to upgrade: ```bash brew update brew upgrade openhue-cli ``` ## Docker The OpenHue CLI is also available from the [DockerHub](https://hub.docker.com/r/openhue/cli). To run it as a container, you first need to pull the image using the following command: ```bash docker pull openhue/cli ``` Then you can run it using: 
# setup command example
docker run -v "${HOME}/.openhue:/.openhue" --rm --name=openhue -it openhue/cli setup -b 192.168.1.x -k xxxxx
# list lights
docker run -v "${HOME}/.openhue:/.openhue" --rm --name=openhue -it openhue/cli get lights
# Setup The OpenHue CLI configuration can be done in less than 30 seconds using the setup command. The first step after [Installation](/cli/installation) is to pair your OpenHue CLI with your local Hue Bridge. Configuration can be either done [manually](#the-config-command) or [automatically](#the-setup-command) using the `setup` command. ## The `setup` command The `setup` command allows to automatically discover your Hue Bridge on your local network, waits for you to push the bridge button and finally saves the configuration in your home folder.

Configure OpenHue CLI with the setup command

Usage: ```bash openhue setup ``` Result: ``` [OK] Found Hue Bridge with IP '192.168.1.15' [..] Please push the button on your Hue Bridge ........ [OK] Successfully paired openhue with your Hue Bridge! [OK] Configuration saved in file /home/.openhue/config.yaml ``` The setup command also allows the set the bridge IP using the `--bridge` parameter: ```bash openhue setup --bridge 192.168.1.100 ``` {% hint style="info" %} You can also easily discover your Hue Bridge IP address by visiting [discovery.meethue.com](https://discovery.meethue.com) {% endhint %} ## The `discover` command The OpenHue CLI provides the `discover` command that allows to easily the IP of your local Hue Bridge using [mDNS Service Discovery](https://en.wikipedia.org/wiki/Multicast_DNS). Usage: ```shell openhue discover ``` Result: ``` 192.168.1.15 ``` ## The `config` command The OpenHue CLI allows you to manually configure the application using the `config` command. The Hue Authentication Key required by the `config` command can be obtained via the [Authentication](/api/openhue-api/authentication) API. Usage: ```bash openhue config --bridge 192.168.1.15 --key xxx ``` Result: ``` [OK] Configuration saved in file /home/.openhue/config.yaml ``` ## Manual Configuration You can still decide to configure the OpenHue CLI completely manually by creating the config file by yourself. OpenHue CLI loads its configuration from a YAML file located in your home directory under the `.openhue` folder. Here are the commands that allows configuring OpenHue CLI manually: ```bash mkdir ~/.openhue touch ~/.openhue/config.yaml echo "bridge: {{REPLACE WITH YOUR BRIDGE IP}}" >> ~/.openhue/config.yaml echo "key: {{REPLACE WITH YOUR KEY}}" >> ~/.openhue/config.yaml ``` ## Troubleshooting When openhue attempts to discover the IP of your bridge using either the [`setup`](#the-setup-command) or [`discover`](#the-discover-command) commands, it is possible your OS might ask you to authorize the application to accept incoming network connections. For instance on MacOs:

mDNS Service Discovery message on MacOs

We will try to find a solution in the future versions, but for now we will ask you to click on Allow. # Commands # Lights Display and control the lights. ## Get Lights Display one or many lights. ### Usage ``` openhue get light [lightId|lightName] [flags] ``` Aliases: `light`, `lights` ### Flags
NameShorthandDefaultUsage
roomrFilter lights by room (name or ID).
jsonjfalseFormat output as JSON
### Examples ``` # List all lights as a table openhue get lights # List all lights as JSON openhue get lights --json # Get details for a single light in JSON format openhue get light aa31ba26-98a7-4830-8ae9-1b7caa8b5700 --json # Get light by name openhue get light "Hue Go" # List all lights for a specific room openhue get light --room "Living Room" ``` ## Set Lights Control one or many lights ### Usage ``` openhue set light [lightId|lightName] [flags] ``` Aliases: `light`, `lights` ### Flags
NameShorthandDefaultUsage
onfalseTurn on the light(s)
offfalseTurn off the light(s)
brightnessbSet the brightness [min=0, max=100]
colorcColor name. See #available-colors
rgbRGB hexadecimal value (example #CCE5FF)
cie-xxX coordinate in the CIE color space
cie-yyY coordinate in the CIE color space
temperaturetColor temperature in Mirek [min=153, max=500]
roomrForce the room of the light(s) in case multiple lights have the same name but belong to different rooms
### Examples ``` # Turn on a light openhue set light 15f51223-1e83-4e48-9158-0c20dbd5734e --on # Turn on multiple lights, using ID or name openhue set light 83111103-a3eb-40c5-b22a-02deedd21fcb "Hue Play TV" --on # Turn off a light identified by name in a specific room openhue set light --room "Living Room" "Hue Play Right" --off # Set brightness of a single light openhue set light 15f51223-1e83-4e48-9158-0c20dbd5734e --on --brightness 42.65 # Set color (in RGB) of a single light openhue set light 15f51223-1e83-4e48-9158-0c20dbd5734e --on --rgb #3399FF # Set color (in CIE space) of a single light openhue set light 15f51223-1e83-4e48-9158-0c20dbd5734e --on -x 0.675 -y 0.322 # Set color (by name) of a single light openhue set light 15f51223-1e83-4e48-9158-0c20dbd5734e --on --color powder_blue # Set color temperature (in Mirek) of a single light openhue set light MyLight --on -t 250 ``` ## Available Colors * `alice_blue` * `antique_white` * `aqua` * `aqua_marine` * `azure` * `beige` * `bisque` * `blanched_almond` * `blue` * `blue_violet` * `brown` * `burly_wood` * `cadet_blue` * `chartreuse` * `chocolate` * `coral` * `corn_flower_blue` * `corn_silk` * `crimson` * `cyan` * `dark_blue` * `dark_cyan` * `dark_golden_rod` * `dark_gray` * `dark_green` * `dark_khaki` * `dark_magenta` * `dark_olive_green` * `dark_orange` * `dark_orchid` * `dark_red` * `dark_salmon` * `dark_sea_green` * `dark_slate_blue` * `dark_slate_gray` * `dark_turquoise` * `dark_violet` * `deep_pink` * `deep_sky_blue` * `dim_gray` * `dodger_blue` * `firebrick` * `floral_white` * `forest_green` * `fuchsia` * `gainsboro` * `ghost_white` * `gold` * `golden_rod` * `gray` * `green` * `green_yellow` * `honeydew` * `hot_pink` * `indian_red` * `indigo` * `ivory` * `khaki` * `lavender` * `lavender_blush` * `lawn_green` * `lemon_chiffon` * `light_blue` * `light_coral` * `light_cyan` * `light_gray` * `light_green` * `light_pink` * `light_salmon` * `light_sea_green` * `light_sky_blue` * `light_slate_gray` * `light_steel_blue` * `light_yellow` * `lime` * `lime_green` * `linen` * `magenta` * `maroon` * `medium_aqua_marine` * `medium_blue` * `medium_orchid` * `medium_purple` * `medium_sea_green` * `medium_slate_blue` * `medium_spring_green` * `medium_turquoise` * `medium_violet_red` * `midnight_blue` * `mint_cream` * `misty_rose` * `moccasin` * `navajo_white` * `navy` * `old_lace` * `olive` * `olive_drab` * `orange` * `orange_red` * `orchid` * `pale_golden_rod` * `pale_green` * `pale_turquoise` * `pale_violet_red` * `papaya_whip` * `peach_puff` * `peru` * `pink` * `plum` * `powder_blue` * `purple` * `red` * `rosy_brown` * `royal_blue` * `saddle_brown` * `salmon` * `sandy_brown` * `sea_green` * `sea_shell` * `sienna` * `silver` * `sky_blue` * `slate_blue` * `slate_gray` * `snow` * `spring_green` * `steel_blue` * `tan` * `teal` * `thistle` * `tomato` * `turquoise` * `violet` * `wheat` * `white` * `white_smoke` * `yellow` * `yellow_green` # Rooms Display and control the lights. ## Get Rooms ### Usage ``` openhue get room [roomId|roomName] [flags] ``` Aliases: `room,` `rooms` ### Flags
NameShorthandDefaultUsage
jsonjfalseFormat output as JSON
### Examples ``` # List all rooms as a table openhue get room # List all rooms as JSON openhue get room --json # Get details for a single room in JSON format openhue get room aa31ba26-98a7-4830-8ae9-1b7caa8b5700 --json # Get room by name openhue get room Studio ``` ## Set Rooms ### Usage ``` openhue set room [roomId] [flags] ``` Aliases: `room,` `rooms` ### Flags
NameShorthandDefaultUsage
onfalseTurn on the light(s)
offfalseTurn off the light(s)
brightnessbSet the brightness [min=0, max=100]
colorcColor name. See #available-colors
rgbRGB hexadecimal value (example #CCE5FF)
cie-xxX coordinate in the CIE color space
cie-yyY coordinate in the CIE color space
temperaturetColor temperature in Mirek [min=153, max=500]
### Examples ``` # Turn on a room openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on # Turn on multiple rooms openhue set room 83111103-a3eb-40c5-b22a-02deedd21fcb 8f0a7b52-df25-4bc7-b94d-0dd1a88068ff --on # Turn off a room identified by name openhue set room Studio --off # Set brightness of a single room openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --brightness 42.65 # Set color (in RGB) of a single room openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --rgb #3399FF # Set color (in CIE space) of a single room openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on -x 0.675 -y 0.322 # Set color (by name) of a single room openhue set room 15f51223-1e83-4e48-9158-0c20dbd5734e --on --color powder_blue # Set color temperature (in Mirek) of a single room openhue set light Studio --on -t 250 ``` # Scenes Display and control the scenes. ## Get Scenes ### Usage ``` openhue get scene [sceneId|sceneName] [flags] ``` Aliases: `scene`, `scenes` ### Flags
NameShorthandDefaultUsage
roomrFilter scenes by room (name or ID)
jsonjfalseFormat output as JSON
### Examples ``` # List all scenes openhue get scene # List all scenes as JSON openhue get scene --json # Filter scenes for a given room name openhue get scenes --room "Living Room" # Filter scenes for a given room ID openhue get scenes -r 878a65d6-613b-4239-8b77-588b535bfb4a # List multiple scenes using either the ID or the name of the scene openhue get scenes "Palm Beach" Nebula 462e54d9-ec5d-4bf6-879d-ad34cb9a692e ``` ## Set Scenes ### Usage ``` openhue set scene [sceneId|sceneName] [flags] ``` Aliases: `scene`, `scenes` ### Flags
NameShorthandDefaultUsage
roomrFilter lights by room (name or ID).
actionaactiveAction to perform on the scene. Allowed: active, dynamic, or static
### Examples ``` # Activate a scene openhue set scene Soho # Activate a scene by ID openhue set scene 62af7df3-d390-4408-a7ac-4b6b8805531b # Activate a scene in a specific room openhue set scene Soho -r Studio # Activate a scene with a dynamic palette openhue set scene Soho -a dynamic ```