Scene
Scenes are used to store and recall settings for a group of lights.
List all available scenes
Scene Success Response
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Conflict
Too Many Requests
Internal Server Error
Service Unavailable
Insufficient Storage
GET /clip/v2/resource/scene HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
"errors": [
{
"description": "text"
}
],
"data": [
{
"type": "scene",
"id": "3883f8bf-30a3-445b-ac06-b047d50599df",
"id_v1": "/lights/8",
"owner": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"actions": [
{
"type": "light",
"id": "3883f8bf-30a3-445b-ac06-b047d50599df",
"id_v1": "/lights/8",
"owner": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"target": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"action": {
"on": {
"on": true
},
"dimming": {
"brightness": 1
},
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"color_temperature": {
"mirek": 1
},
"gradient": {
"points": [
{
"xy": {
"x": 1,
"y": 1
}
}
],
"mode": "interpolated_palette"
},
"effects": {
"effect": "prism"
}
}
}
],
"metadata": {
"name": "text",
"image": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"appdata": "text"
},
"group": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"palette": {
"color": [
{
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"dimming": {
"brightness": 1
}
}
],
"dimming": [
{
"brightness": 1
}
],
"color_temperature": [
{
"color_temperature": {
"mirek": 1
},
"dimming": {
"brightness": 1
}
}
],
"effects": [
{
"effect": "prism"
}
]
},
"speed": 1,
"auto_dynamic": true,
"status": {
"active": "inactive"
}
}
]
}
Creates a new scene
Speed of dynamic palette for this scene
Indicates whether to automatically start the scene dynamically on active recall
Success
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Conflict
Too Many Requests
Internal Server Error
Service Unavailable
Insufficient Storage
POST /clip/v2/resource/scene HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 790
{
"type": "scene",
"actions": [
{
"target": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"action": {
"on": {
"on": true
},
"dimming": {
"brightness": 1
},
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"color_temperature": {
"mirek": 1
},
"gradient": {
"points": [
{
"xy": {
"x": 1,
"y": 1
}
}
],
"mode": "interpolated_palette"
},
"effects": {
"effect": "prism"
},
"dynamics": {
"duration": 1
}
}
}
],
"metadata": {
"name": "text",
"image": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"appdata": "text"
},
"group": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"palette": {
"color": [
{
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"dimming": {
"brightness": 1
}
}
],
"dimming": [
{
"brightness": 1
}
],
"color_temperature": [
{
"color_temperature": {
"mirek": 1
},
"dimming": {
"brightness": 1
}
}
],
"effects": [
{
"effect": "prism"
}
]
},
"speed": 1,
"auto_dynamic": true
}
{
"errors": [
{
"description": "text"
}
],
"data": [
{
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
}
]
}
Get details of a single scene from its given {sceneId}
ID of the scene.
Scene Success Response
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Conflict
Too Many Requests
Internal Server Error
Service Unavailable
Insufficient Storage
GET /clip/v2/resource/scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
"errors": [
{
"description": "text"
}
],
"data": [
{
"type": "scene",
"id": "3883f8bf-30a3-445b-ac06-b047d50599df",
"id_v1": "/lights/8",
"owner": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"actions": [
{
"type": "light",
"id": "3883f8bf-30a3-445b-ac06-b047d50599df",
"id_v1": "/lights/8",
"owner": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"target": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"action": {
"on": {
"on": true
},
"dimming": {
"brightness": 1
},
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"color_temperature": {
"mirek": 1
},
"gradient": {
"points": [
{
"xy": {
"x": 1,
"y": 1
}
}
],
"mode": "interpolated_palette"
},
"effects": {
"effect": "prism"
}
}
}
],
"metadata": {
"name": "text",
"image": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"appdata": "text"
},
"group": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"palette": {
"color": [
{
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"dimming": {
"brightness": 1
}
}
],
"dimming": [
{
"brightness": 1
}
],
"color_temperature": [
{
"color_temperature": {
"mirek": 1
},
"dimming": {
"brightness": 1
}
}
],
"effects": [
{
"effect": "prism"
}
]
},
"speed": 1,
"auto_dynamic": true,
"status": {
"active": "inactive"
}
}
]
}
Update a single scene from its given {sceneId}
ID of the scene.
Speed of dynamic palette for this scene
Indicates whether to automatically start the scene dynamically on active recall
Success
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Conflict
Too Many Requests
Internal Server Error
Service Unavailable
Insufficient Storage
PUT /clip/v2/resource/scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 787
{
"type": "scene",
"actions": [
{
"target": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"action": {
"on": {
"on": true
},
"dimming": {
"brightness": 1
},
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"color_temperature": {
"mirek": 1
},
"gradient": {
"points": [
{
"xy": {
"x": 1,
"y": 1
}
}
],
"mode": "interpolated_palette"
},
"effects": {
"effect": "prism"
},
"dynamics": {
"duration": 1
}
}
}
],
"recall": {
"action": "active",
"duration": 1,
"dimming": {
"brightness": 1
}
},
"metadata": {
"name": "text",
"image": {
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
},
"appdata": "text"
},
"palette": {
"color": [
{
"color": {
"xy": {
"x": 1,
"y": 1
}
},
"dimming": {
"brightness": 1
}
}
],
"dimming": [
{
"brightness": 1
}
],
"color_temperature": [
{
"color_temperature": {
"mirek": 1
},
"dimming": {
"brightness": 1
}
}
],
"effects": [
{
"effect": "prism"
}
]
},
"speed": 1,
"auto_dynamic": true
}
{
"errors": [
{
"description": "text"
}
],
"data": [
{
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
}
]
}
Delete a single scene from its given {sceneId}
ID of the scene.
Success
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Conflict
Too Many Requests
Internal Server Error
Service Unavailable
Insufficient Storage
DELETE /clip/v2/resource/scene/{sceneId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
"errors": [
{
"description": "text"
}
],
"data": [
{
"rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
"rtype": "device"
}
]
}
Last updated
Was this helpful?