> For the complete documentation index, see [llms.txt](https://www.openhue.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.openhue.io/api/openhue-api-1/device.md).

# Device

API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted.

## List devices

> List all available devices

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"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."}}},"DeviceGet":{"type":"object","description":"Definition of a device resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["product_data","metadata","identify","services"],"properties":{"type":{"type":"string","enum":["device"]},"product_data":{"$ref":"#/components/schemas/ProductData"},"metadata":{"type":"object","required":["name","archetype"],"properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","description":"Triggers a visual identification sequence on the device"},"usertest":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode.\nIn usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)\n"}}},"services":{"type":"array","description":"References all services providing control and state of the device.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"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"]}}},"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"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/device":{"get":{"operationId":"getDevices","summary":"List devices","description":"List all available devices","tags":["Device"],"responses":{"200":{"description":"Device Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGet"}}}}]}}}},"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 device

> Get details of a single device from its given \`{deviceId}\`.

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"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."}}},"DeviceGet":{"type":"object","description":"Definition of a device resource","allOf":[{"$ref":"#/components/schemas/ResourceOwned"},{"type":"object","required":["product_data","metadata","identify","services"],"properties":{"type":{"type":"string","enum":["device"]},"product_data":{"$ref":"#/components/schemas/ProductData"},"metadata":{"type":"object","required":["name","archetype"],"properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","description":"Triggers a visual identification sequence on the device"},"usertest":{"type":"object","properties":{"status":{"type":"string","enum":["set","changing"]},"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode.\nIn usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)\n"}}},"services":{"type":"array","description":"References all services providing control and state of the device.","items":{"$ref":"#/components/schemas/ResourceIdentifier"}}}}]},"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"]}}},"ProductData":{"type":"object","required":["model_id","manufacturer_name","product_name","product_archetype","certified","software_version"],"properties":{"model_id":{"type":"string","description":"Unique identification of device model"},"manufacturer_name":{"type":"string","description":"Name of device manufacturer"},"product_name":{"type":"string","description":"Name of the product"},"product_archetype":{"$ref":"#/components/schemas/ProductArchetype"},"certified":{"type":"boolean","description":"This device is Hue certified"},"software_version":{"type":"string","description":"Software version of the product","pattern":"\\d+\\.\\d+\\.\\d+"},"hardware_platform_type":{"type":"string","description":"Hardware type; identified by Manufacturer code and ImageType"}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"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/device/{deviceId}":{"get":{"operationId":"getDevice","summary":"Get device","description":"Get details of a single device from its given `{deviceId}`.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device"}],"responses":{"200":{"description":"Device Success Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGet"}}}}]}}}},"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 device

> Update a single device from its given \`{deviceId}\`.

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"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":{"DevicePut":{"type":"object","properties":{"type":{"type":"string","enum":["device"]},"metadata":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"Human readable name of a resource"},"archetype":{"$ref":"#/components/schemas/ProductArchetype"}}},"identify":{"type":"object","properties":{"action":{"type":"string","description":"Triggers a visual identification sequence, current implemented as (which can change in the future):\nBridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors\nperform LED identification cycles for 15 seconds\n","enum":["identify"]}}},"usertest":{"type":"object","properties":{"usertest":{"type":"boolean","description":"Activates or extends user usertest mode of device for 120 seconds.\n`false` deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate\nstate changes on device LED (if applicable)\n"}}}}},"ProductArchetype":{"type":"string","description":"The default archetype given by manufacturer. Can be changed by user.","enum":["bridge_v2","unknown_archetype","classic_bulb","sultan_bulb","flood_bulb","spot_bulb","candle_bulb","luster_bulb","pendant_round","pendant_long","ceiling_round","ceiling_square","floor_shade","floor_lantern","table_shade","recessed_ceiling","recessed_floor","single_spot","double_spot","table_wash","wall_lantern","wall_shade","flexible_lamp","ground_spot","wall_spot","plug","hue_go","hue_lightstrip","hue_iris","hue_bloom","bollard","wall_washer","hue_play","vintage_bulb","vintage_candle_bulb","ellipse_bulb","triangle_bulb","small_globe_bulb","large_globe_bulb","edison_bulb","christmas_tree","string_light","hue_centris","hue_lightstrip_tv","hue_lightstrip_pc","hue_tube","hue_signe","pendant_spot","ceiling_horizontal","ceiling_tube"]},"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/device/{deviceId}":{"put":{"operationId":"updateDevice","summary":"Update device","description":"Update a single device from its given `{deviceId}`.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the device"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevicePut"}}}},"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 Device

> Delete a single Device from its given \`{deviceId}\`. The \`bridge\` device cannot be deleted.

```json
{"openapi":"3.0.3","info":{"title":"Hue CLIP API","version":"v2"},"tags":[{"name":"Device","description":"API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted."}],"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/device/{deviceId}":{"delete":{"operationId":"deleteDevice","summary":"Delete Device","description":"Delete a single Device from its given `{deviceId}`. The `bridge` device cannot be deleted.","tags":["Device"],"parameters":[{"name":"deviceId","in":"path","schema":{"type":"string"},"required":true,"description":"ID of the Device"}],"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"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.openhue.io/api/openhue-api-1/device.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.