Light

These are offered by devices with lighting capabilities.

PreviousDevice NextScene

Last updated 1 year ago

Was this helpful?

List lights.

get

List all available lights.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/light' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

{
  "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",
        "fixed_mired": 1
      },
      "on": {
        "on": true
      },
      "dimming": {
        "brightness": 1,
        "min_dim_level": 1
      },
      "color_temperature": {
        "mirek": 1,
        "mirek_valid": true,
        "mirek_schema": {
          "mirek_minimum": 1,
          "mirek_maximum": 1
        }
      },
      "color": {
        "xy": {
          "x": 1,
          "y": 1
        },
        "gamut": {
          "red": {
            "x": 1,
            "y": 1
          },
          "green": {
            "x": 1,
            "y": 1
          },
          "blue": {
            "x": 1,
            "y": 1
          }
        },
        "gamut_type": "A"
      },
      "dynamics": {
        "status": "dynamic_palette",
        "status_values": [
          "dynamic_palette"
        ],
        "speed": 1,
        "speed_valid": true
      },
      "alert": {},
      "signaling": {
        "signal_values": [
          "no_signal"
        ],
        "estimated_end": 1,
        "colors": [
          {
            "xy": {
              "x": 1,
              "y": 1
            }
          }
        ]
      },
      "mode": "normal",
      "gradient": {
        "points": [
          {
            "xy": {
              "x": 1,
              "y": 1
            }
          }
        ],
        "mode": "interpolated_palette",
        "points_capable": 1,
        "mode_values": [
          "interpolated_palette"
        ],
        "pixel_count": 1
      },
      "effects": {
        "status": "prism",
        "status_values": [
          "prism"
        ],
        "effect": "prism",
        "effect_values": [
          "prism"
        ]
      },
      "timed_effects": {
        "effect": "sunrise",
        "effect_values": [
          "sunrise"
        ],
        "status": "sunrise",
        "status_values": [
          "sunrise"
        ],
        "duration": 1
      },
      "powerup": {
        "preset": "safety",
        "configured": true,
        "on": {
          "mode": "on",
          "on": {
            "on": true
          }
        },
        "dimming": {
          "mode": "dimming",
          "dimming": {
            "brightness": 1
          },
          "color": {
            "mode": "color_temperature",
            "color_temperature": {
              "mirek": 1,
              "color": {
                "xy": {
                  "x": 1,
                  "y": 1
                }
              }
            }
          }
        }
      }
    }
  ]
}

Light Success Response

Get light

get

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

Authorizations

Path parameters

lightIdstringrequired

ID of the light

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/light/{lightId}' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

{
  "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",
        "fixed_mired": 1
      },
      "on": {
        "on": true
      },
      "dimming": {
        "brightness": 1,
        "min_dim_level": 1
      },
      "color_temperature": {
        "mirek": 1,
        "mirek_valid": true,
        "mirek_schema": {
          "mirek_minimum": 1,
          "mirek_maximum": 1
        }
      },
      "color": {
        "xy": {
          "x": 1,
          "y": 1
        },
        "gamut": {
          "red": {
            "x": 1,
            "y": 1
          },
          "green": {
            "x": 1,
            "y": 1
          },
          "blue": {
            "x": 1,
            "y": 1
          }
        },
        "gamut_type": "A"
      },
      "dynamics": {
        "status": "dynamic_palette",
        "status_values": [
          "dynamic_palette"
        ],
        "speed": 1,
        "speed_valid": true
      },
      "alert": {},
      "signaling": {
        "signal_values": [
          "no_signal"
        ],
        "estimated_end": 1,
        "colors": [
          {
            "xy": {
              "x": 1,
              "y": 1
            }
          }
        ]
      },
      "mode": "normal",
      "gradient": {
        "points": [
          {
            "xy": {
              "x": 1,
              "y": 1
            }
          }
        ],
        "mode": "interpolated_palette",
        "points_capable": 1,
        "mode_values": [
          "interpolated_palette"
        ],
        "pixel_count": 1
      },
      "effects": {
        "status": "prism",
        "status_values": [
          "prism"
        ],
        "effect": "prism",
        "effect_values": [
          "prism"
        ]
      },
      "timed_effects": {
        "effect": "sunrise",
        "effect_values": [
          "sunrise"
        ],
        "status": "sunrise",
        "status_values": [
          "sunrise"
        ],
        "duration": 1
      },
      "powerup": {
        "preset": "safety",
        "configured": true,
        "on": {
          "mode": "on",
          "on": {
            "on": true
          }
        },
        "dimming": {
          "mode": "dimming",
          "dimming": {
            "brightness": 1
          },
          "color": {
            "mode": "color_temperature",
            "color_temperature": {
              "mirek": 1,
              "color": {
                "xy": {
                  "x": 1,
                  "y": 1
                }
              }
            }
          }
        }
      }
    }
  ]
}

Light Success Response

List grouped lights

get

List all grouped lights

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/grouped_light' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

{
  "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": true
      },
      "dimming": {
        "brightness": 1
      },
      "alert": {
        "action_values": [
          "breathe"
        ]
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ]
      }
    }
  ]
}

Grouped Light Success Response

Get grouped light

get

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

Authorizations

Path parameters

groupedLightIdstringrequired

ID of the grouped light

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/grouped_light/{groupedLightId}' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

{
  "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": true
      },
      "dimming": {
        "brightness": 1
      },
      "alert": {
        "action_values": [
          "breathe"
        ]
      },
      "signaling": {
        "signal_values": [
          "no_signal"
        ]
      }
    }
  ]
}

Grouped Light Success Response

Update light

put

Update a single light from its given {lightId}.

Authorizations

Path parameters

lightIdstringrequired

ID of the light

Body

typestringoptional

Type of the supported resources (always light here)

onobjectoptional

dimmingobjectoptional

dimming_deltaobjectoptional

color_temperatureobjectoptional

color_temperature_deltaobjectoptional

colorobjectoptional

dynamicsobjectoptional

alertobjectoptional

Joined alert control

signalingobjectoptional

Feature containing basic signaling properties.

modestring · enumoptional

Options: normal, streaming

gradientobjectoptional

Basic feature containing gradient properties.

effectsobjectoptional

Basic feature containing effect properties.

timed_effectsobjectoptional

Basic feature containing timed effect properties.

powerupobjectoptional

Feature containing properties to configure powerup behaviour of a lightsource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://192.168.1.0/clip/v2/resource/light/{lightId}' \
  --header 'hue-application-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "on": {
      "on": true
    }
  }'

200

401

403

404

405

406

409

429

500

503

507

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

Success

Update grouped light

put

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

Authorizations

Path parameters

groupedLightIdstringrequired

ID of the light

Body

typestring · enumoptional

Type of the supported resources (always grouped_light here)

Options: grouped_light

onobjectoptional

dimmingobjectoptional

dimming_deltaobjectoptional

color_temperatureobjectoptional

color_temperature_deltaobjectoptional

colorobjectoptional

alertobjectoptional

Joined alert control

signalingobjectoptional

Feature containing basic signaling properties.

dynamicsobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://192.168.1.0/clip/v2/resource/grouped_light/{groupedLightId}' \
  --header 'hue-application-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "on": {
      "on": true
    }
  }'

200

401

403

404

405

406

409

429

500

503

507

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

Success

Grouped Light

Grouped Light

List lights.

Get light

List grouped lights

Get grouped light

Update light

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Update grouped light

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes