# Scene

API to manage scenes. Scenes are used to store and recall settings for a group of lights.

## List scenes

> List all available scenes

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["actions","metadata","group","speed","auto_dynamic","status"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionGet"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"},"status":{"type":"object","properties":{"active":{"type":"string","enum":["inactive","static","dynamic_palette"]}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene":{"get":{"operationId":"getScenes","summary":"List scenes","description":"List all available scenes","tags":["Scene"],"responses":{"200":{"description":"Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Create a new scene

> Creates a new scene

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ScenePost":{"type":"object","required":["actions","metadata","group"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene":{"post":{"operationId":"createScene","summary":"Create a new scene","description":"Creates a new scene","tags":["Scene"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenePost"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Get a scene

> Get details of a single scene from its given \`{sceneId}\`

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"SceneGet":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["actions","metadata","group","speed","auto_dynamic","status"],"properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionGet"}},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"group":{"$ref":"#/components/schemas/ResourceIdentifier"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"},"status":{"type":"object","properties":{"active":{"type":"string","enum":["inactive","static","dynamic_palette"]}}}}}]},"ResourceOwned":{"type":"object","description":"Common resource properties including the owner","allOf":[{"$ref":"#/components/schemas/Resource"},{"type":"object","required":["owner"],"properties":{"owner":{"$ref":"#/components/schemas/ResourceIdentifier"}}}]},"Resource":{"type":"object","description":"Common resource properties","required":["type","id"],"properties":{"type":{"type":"string","description":"Type of the supported resources"},"id":{"type":"string","description":"Unique identifier representing a specific resource instance","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"id_v1":{"type":"string","description":"Clip v1 resource identifier","pattern":"^(\\/[a-z]{4,32}\\/[0-9a-zA-Z-]{1,32})?$"}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ActionGet":{"type":"object","required":["target","action"],"properties":{"target":{"description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"$ref":"#/components/schemas/ColorTemperature"},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"ColorTemperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"get":{"operationId":"getScene","summary":"Get a scene","description":"Get details of a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"responses":{"200":{"description":"Scene Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SceneGet"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Update a scene

> Update a single scene from its given \`{sceneId}\`

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ScenePut":{"type":"object","properties":{"type":{"type":"string","enum":["scene"]},"actions":{"type":"array","description":"List of actions to be executed synchronously on recall","items":{"$ref":"#/components/schemas/ActionPost"}},"recall":{"$ref":"#/components/schemas/SceneRecall"},"metadata":{"$ref":"#/components/schemas/SceneMetadata"},"palette":{"$ref":"#/components/schemas/ScenePalette"},"speed":{"type":"number","minimum":0,"maximum":1,"description":"Speed of dynamic palette for this scene"},"auto_dynamic":{"type":"boolean","description":"Indicates whether to automatically start the scene dynamically on active recall"}}},"ActionPost":{"type":"object","required":["target","action"],"properties":{"target":{"type":"object","description":"The identifier of the light to execute the action on","$ref":"#/components/schemas/ResourceIdentifier"},"action":{"type":"object","description":"The action to be executed on recall","properties":{"on":{"$ref":"#/components/schemas/On"},"dimming":{"$ref":"#/components/schemas/Dimming"},"color":{"$ref":"#/components/schemas/Color"},"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"gradient":{"$ref":"#/components/schemas/Gradient"},"effects":{"type":"object","description":"Basic feature containing effect properties.","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}},"dynamics":{"$ref":"#/components/schemas/Dynamics"}}}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"On":{"type":"object","required":["on"],"properties":{"on":{"type":"boolean","description":"On/Off state of the light on=true, off=false"}}},"Dimming":{"type":"object","required":["brightness"],"properties":{"brightness":{"$ref":"#/components/schemas/Brightness"}}},"Brightness":{"type":"number","minimum":0,"maximum":100,"description":"Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness"},"Color":{"type":"object","required":["xy"],"properties":{"xy":{"$ref":"#/components/schemas/GamutPosition"}}},"GamutPosition":{"type":"object","description":"CIE XY gamut position","required":["x","y"],"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"X position in color gamut"},"y":{"type":"number","minimum":0,"maximum":1,"description":"y position in color gamut"}}},"Mirek":{"type":"integer","minimum":153,"maximum":500,"description":"color temperature in mirek or null when the light color is not in the ct spectrum"},"Gradient":{"type":"object","description":"Basic feature containing gradient properties.","properties":{"points":{"type":"array","description":"Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.","items":{"$ref":"#/components/schemas/Color"},"maxItems":5},"mode":{"$ref":"#/components/schemas/SupportedGradientMode"}}},"SupportedGradientMode":{"type":"string","description":"Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette","enum":["interpolated_palette","interpolated_palette_mirrored","random_pixelated"]},"SupportedEffects":{"type":"string","enum":["prism","opal","glisten","sparkle","fire","candle","no_effect","underwater","cosmos","sunbeam","enchant"]},"Dynamics":{"type":"object","properties":{"duration":{"type":"integer","minimum":0,"description":"Duration of a light transition or timed effects in ms."}}},"SceneRecall":{"type":"object","properties":{"action":{"type":"string","description":"When writing active, the actions in the scene are executed on the target. dynamic_palette starts dynamic scene with colors in the Palette object.","enum":["active","dynamic_palette","static"]},"duration":{"type":"integer","description":"Transition to the scene within the timeframe given by duration"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"SceneMetadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"image":{"$ref":"#/components/schemas/ResourceIdentifier"},"appdata":{"type":"string","minLength":1,"maxLength":16,"description":"Application specific data. Free format string."}}},"ScenePalette":{"type":"object","description":"Group of colors that describe the palette of colors to be used when playing dynamics","properties":{"color":{"type":"array","minItems":0,"maxItems":9,"items":{"$ref":"#/components/schemas/ColorPaletteGet"}},"dimming":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Dimming"}},"color_temperature":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/ColorTemperaturePalettePost"}},"effects":{"type":"array","minItems":0,"maxItems":3,"items":{"type":"object","properties":{"effect":{"$ref":"#/components/schemas/SupportedEffects"}}}}}},"ColorPaletteGet":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/Color"},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ColorTemperaturePalettePost":{"type":"object","properties":{"color_temperature":{"type":"object","properties":{"mirek":{"$ref":"#/components/schemas/Mirek"}}},"dimming":{"$ref":"#/components/schemas/Dimming"}}},"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"put":{"operationId":"updateScene","summary":"Update a scene","description":"Update a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenePut"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```

## Delete a scene

> Delete a single scene from its given \`{sceneId}\`

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Scene","description":"API to manage scenes. Scenes are used to store and recall settings for a group of lights."}],"servers":[{"url":"https://{bridgeInternalIPAddress}","description":"Your Home Bridge","variables":{"bridgeInternalIPAddress":{"default":"192.168.1.0","description":"Use the broker server discover process by visiting https://discovery.meethue.com\nto discover the IP address of the bridge on your network\n"}}}],"security":[{"HueApplicationKey":[]}],"components":{"securitySchemes":{"HueApplicationKey":{"type":"apiKey","in":"header","name":"hue-application-key"}},"schemas":{"ApiResponse":{"type":"object","required":["errors","data"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"data":{"type":"array","items":{"type":"object"}}}},"Error":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem."}}},"ResourceIdentifier":{"type":"object","required":["rid","rtype"],"properties":{"rid":{"type":"string","description":"The unique id of the referenced resource","pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$"},"rtype":{"type":"string","description":"The type of the referenced resource","enum":["device","bridge_home","room","zone","light","button","relative_rotary","temperature","light_level","motion","camera_motion","entertainment","contact","tamper","grouped_light","device_power","zigbee_bridge_connectivity","zigbee_connectivity","zgp_connectivity","bridge","zigbee_device_discovery","homekit","matter","matter_fabric","scene","entertainment_configuration","public_image","auth_v1","behavior_script","behavior_instance","geofence","geofence_client","geolocation","smart_scene","grouped_motion","grouped_light_level"]}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotAcceptable":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InsufficientStorage":{"description":"Insufficient Storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/clip/v2/resource/scene/{sceneId}":{"delete":{"operationId":"deleteScene","summary":"Delete a scene","description":"Delete a single scene from its given `{sceneId}`","tags":["Scene"],"parameters":[{"name":"sceneId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the scene."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"507":{"$ref":"#/components/responses/InsufficientStorage"}}}}}}
```