# 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})?$"}}}}}}
```