Scene

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

List scenes

List all available scenes

GEThttps://192.168.1.0/clip/v2/resource/scene

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Scene Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of SceneGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/scene', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false
            },
            "dimming": {
              "brightness": 0
            },
            "color": {
              "xy": {
                "x": 0,
                "y": 0
              }
            },
            "color_temperature": {},
            "gradient": {
              "points": [
                {
                  "xy": {
                    "x": 0,
                    "y": 0
                  }
                }
              ],
              "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": 0,
                "y": 0
              }
            },
            "dimming": {
              "brightness": 0
            }
          }
        ],
        "dimming": [
          {
            "brightness": 0
          }
        ],
        "color_temperature": [
          {
            "color_temperature": {},
            "dimming": {
              "brightness": 0
            }
          }
        ],
        "effects": [
          {
            "effect": "prism"
          }
        ]
      },
      "speed": 0,
      "auto_dynamic": false,
      "status": {
        "active": "inactive"
      }
    }
  ]
}

Create a new scene

Creates a new scene

POSThttps://192.168.1.0/clip/v2/resource/scene

Authorization

HueApplicationKey

Body

application/json

typeenum

scene

actions*array of ActionPost (object)

List of actions to be executed synchronously on recall

metadata*SceneMetadata (object)

group*ResourceIdentifier (object)

paletteScenePalette (object)

Group of colors that describe the palette of colors to be used when playing dynamics

speednumber

Speed of dynamic palette for this scene

auto_dynamicboolean

Indicates whether to automatically start the scene dynamically on active recall

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/scene', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actions": [
        {
          "target": {},
          "action": {}
        }
      ],
      "metadata": {},
      "group": {}
    }),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get a scene

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

GEThttps://192.168.1.0/clip/v2/resource/scene/{sceneId}

Authorization

HueApplicationKey

Path parameters

sceneId*string

ID of the scene.

Response

200401403404405406409429500503507

Scene Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of SceneGet (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/scene/{sceneId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false
            },
            "dimming": {
              "brightness": 0
            },
            "color": {
              "xy": {
                "x": 0,
                "y": 0
              }
            },
            "color_temperature": {},
            "gradient": {
              "points": [
                {
                  "xy": {
                    "x": 0,
                    "y": 0
                  }
                }
              ],
              "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": 0,
                "y": 0
              }
            },
            "dimming": {
              "brightness": 0
            }
          }
        ],
        "dimming": [
          {
            "brightness": 0
          }
        ],
        "color_temperature": [
          {
            "color_temperature": {},
            "dimming": {
              "brightness": 0
            }
          }
        ],
        "effects": [
          {
            "effect": "prism"
          }
        ]
      },
      "speed": 0,
      "auto_dynamic": false,
      "status": {
        "active": "inactive"
      }
    }
  ]
}

Update a scene

Update a single scene from its given {sceneId}

PUThttps://192.168.1.0/clip/v2/resource/scene/{sceneId}

Authorization

HueApplicationKey

Path parameters

sceneId*string

ID of the scene.

Body

application/json

typeenum

scene

actionsarray of ActionPost (object)

List of actions to be executed synchronously on recall

recallSceneRecall (object)

metadataSceneMetadata (object)

paletteScenePalette (object)

Group of colors that describe the palette of colors to be used when playing dynamics

speednumber

Speed of dynamic palette for this scene

auto_dynamicboolean

Indicates whether to automatically start the scene dynamically on active recall

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/scene/{sceneId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Delete a scene

Delete a single scene from its given {sceneId}

DELETEhttps://192.168.1.0/clip/v2/resource/scene/{sceneId}

Authorization

HueApplicationKey

Path parameters

sceneId*string

ID of the scene.

Response

200401403404405406409429500503507

Success

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of ResourceIdentifier (object)

Request

JavaScriptCurl

const response = await fetch('https://192.168.1.0/clip/v2/resource/scene/{sceneId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}