Light

These are offered by devices with lighting capabilities.

List lights.

List all available lights.

GEThttps://192.168.1.0/clip/v2/resource/light

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Light Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of LightGet (object)

Request

JavaScriptCurl

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

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "metadata": {
        "name": "text",
        "archetype": "classic_bulb"
      },
      "on": {
        "on": false
      },
      "dimming": {
        "brightness": 0,
        "min_dim_level": 0
      },
      "color_temperature": {
        "mirek_valid": false,
        "mirek_schema": {}
      },
      "color": {
        "xy": {
          "x": 0,
          "y": 0
        },
        "gamut": {
          "red": {
            "x": 0,
            "y": 0
          },
          "green": {
            "x": 0,
            "y": 0
          },
          "blue": {
            "x": 0,
            "y": 0
          }
        },
        "gamut_type": "A"
      },
      "dynamics": {
        "status": "dynamic_palette",
        "status_values": [
          "dynamic_palette"
        ],
        "speed": 0,
        "speed_valid": false
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ],
        "colors": [
          {
            "xy": {
              "x": 0,
              "y": 0
            }
          }
        ]
      },
      "mode": "normal",
      "gradient": {
        "points": [
          {
            "xy": {
              "x": 0,
              "y": 0
            }
          }
        ],
        "mode": "interpolated_palette",
        "mode_values": [
          "interpolated_palette"
        ]
      },
      "effects": {
        "status": "prism",
        "status_values": [
          "prism"
        ],
        "effect": "prism",
        "effect_values": [
          "prism"
        ]
      },
      "timed_effects": {
        "effect": "sunrise",
        "effect_values": [
          "sunrise"
        ],
        "status": "sunrise",
        "status_values": [
          "sunrise"
        ]
      },
      "powerup": {
        "preset": "safety",
        "configured": false,
        "on": {
          "mode": "on",
          "on": {
            "on": false
          }
        },
        "dimming": {
          "mode": "dimming",
          "dimming": {
            "brightness": 0
          },
          "color": {
            "mode": "color_temperature",
            "color_temperature": {
              "color": {
                "xy": {
                  "x": 0,
                  "y": 0
                }
              }
            }
          }
        }
      }
    }
  ]
}

Get light

Get details of a single light from its given {lightId}.

GEThttps://192.168.1.0/clip/v2/resource/light/{lightId}

Authorization

HueApplicationKey

Path parameters

lightId*string

ID of the light

Response

200401403404405406409429500503507

Light Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of LightGet (object)

Request

JavaScriptCurl

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

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "metadata": {
        "name": "text",
        "archetype": "classic_bulb"
      },
      "on": {
        "on": false
      },
      "dimming": {
        "brightness": 0,
        "min_dim_level": 0
      },
      "color_temperature": {
        "mirek_valid": false,
        "mirek_schema": {}
      },
      "color": {
        "xy": {
          "x": 0,
          "y": 0
        },
        "gamut": {
          "red": {
            "x": 0,
            "y": 0
          },
          "green": {
            "x": 0,
            "y": 0
          },
          "blue": {
            "x": 0,
            "y": 0
          }
        },
        "gamut_type": "A"
      },
      "dynamics": {
        "status": "dynamic_palette",
        "status_values": [
          "dynamic_palette"
        ],
        "speed": 0,
        "speed_valid": false
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ],
        "colors": [
          {
            "xy": {
              "x": 0,
              "y": 0
            }
          }
        ]
      },
      "mode": "normal",
      "gradient": {
        "points": [
          {
            "xy": {
              "x": 0,
              "y": 0
            }
          }
        ],
        "mode": "interpolated_palette",
        "mode_values": [
          "interpolated_palette"
        ]
      },
      "effects": {
        "status": "prism",
        "status_values": [
          "prism"
        ],
        "effect": "prism",
        "effect_values": [
          "prism"
        ]
      },
      "timed_effects": {
        "effect": "sunrise",
        "effect_values": [
          "sunrise"
        ],
        "status": "sunrise",
        "status_values": [
          "sunrise"
        ]
      },
      "powerup": {
        "preset": "safety",
        "configured": false,
        "on": {
          "mode": "on",
          "on": {
            "on": false
          }
        },
        "dimming": {
          "mode": "dimming",
          "dimming": {
            "brightness": 0
          },
          "color": {
            "mode": "color_temperature",
            "color_temperature": {
              "color": {
                "xy": {
                  "x": 0,
                  "y": 0
                }
              }
            }
          }
        }
      }
    }
  ]
}

Update light

Update a single light from its given {lightId}.

PUThttps://192.168.1.0/clip/v2/resource/light/{lightId}

Authorization

HueApplicationKey

Path parameters

lightId*string

ID of the light

Body

application/json

typestring

Type of the supported resources (always light here)

onOn (object)

dimmingDimming (object)

dimming_deltaDimmingDelta (object)

color_temperatureColorTemperature (object)

color_temperature_deltaColorTemperatureDelta (object)

colorColor (object)

dynamicsDynamics (object)

alertAlert (object)

Joined alert control

signalingSignaling (object)

Feature containing basic signaling properties.

modeenum

normalstreaming

gradientGradient (object)

Basic feature containing gradient properties.

effectsEffects (object)

Basic feature containing effect properties.

timed_effectsobject

Basic feature containing timed effect properties.

powerupPowerup (object)

Feature containing properties to configure powerup behaviour of a lightsource.

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/light/{lightId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "on": {
        "on": true
      }
    }),
});
const data = await response.json();

Response

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

Grouped Light

These are offered by rooms, zones, and homes.

List grouped lights

List all grouped lights

GEThttps://192.168.1.0/clip/v2/resource/grouped_light

Authorization

HueApplicationKey

Response

200401403404405406409429500503507

Grouped Light Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of GroupedLightGet (object)

Request

JavaScriptCurl

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

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "on": {
        "on": false
      },
      "dimming": {
        "brightness": 0
      },
      "alert": {
        "action_values": [
          "breathe"
        ]
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ]
      }
    }
  ]
}

Get grouped light

Get details of a single grouped light from its given {groupedLightId}.

GEThttps://192.168.1.0/clip/v2/resource/grouped_light/{groupedLightId}

Authorization

HueApplicationKey

Path parameters

groupedLightId*string

ID of the grouped light

Response

200401403404405406409429500503507

Grouped Light Success Response

Body

application/json

errorsarray of Error (object)

dataarray of object

dataarray of GroupedLightGet (object)

Request

JavaScriptCurl

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

Response

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "on": {
        "on": false
      },
      "dimming": {
        "brightness": 0
      },
      "alert": {
        "action_values": [
          "breathe"
        ]
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ]
      }
    }
  ]
}

Update grouped light

Update a single grouped light from its given {groupedLightId}.

PUThttps://192.168.1.0/clip/v2/resource/grouped_light/{groupedLightId}

Authorization

HueApplicationKey

Path parameters

groupedLightId*string

ID of the light

Body

application/json

typeenum

Type of the supported resources (always grouped_light here)

grouped_light

onOn (object)

dimmingDimming (object)

dimming_deltaDimmingDelta (object)

color_temperatureColorTemperature (object)

color_temperature_deltaColorTemperatureDelta (object)

colorColor (object)

alertAlert (object)

Joined alert control

signalingSignaling (object)

Feature containing basic signaling properties.

dynamicsDynamics-2 (object)

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/grouped_light/{groupedLightId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "on": {
        "on": true
      }
    }),
});
const data = await response.json();

Response

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