Device

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

List devices

get

List all available devices

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

Device Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/device

HTTPcURLJavaScriptPython

GET /clip/v2/resource/device HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "device",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "product_data": {
        "model_id": "7602031P7",
        "manufacturer_name": "Signify Netherlands B.V.",
        "product_name": "Hue Go",
        "product_archetype": "hue_go",
        "certified": true,
        "software_version": "1.104.3",
        "hardware_platform_type": "100b-120"
      },
      "metadata": {
        "name": "text",
        "archetype": "hue_go"
      },
      "identify": {},
      "usertest": {
        "status": "set",
        "usertest": true
      },
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Get device

get

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

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

deviceIdstringRequired

ID of the device

Responses

200

Device Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/device/{deviceId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/device/{deviceId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "device",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "product_data": {
        "model_id": "7602031P7",
        "manufacturer_name": "Signify Netherlands B.V.",
        "product_name": "Hue Go",
        "product_archetype": "hue_go",
        "certified": true,
        "software_version": "1.104.3",
        "hardware_platform_type": "100b-120"
      },
      "metadata": {
        "name": "text",
        "archetype": "hue_go"
      },
      "identify": {},
      "usertest": {
        "status": "set",
        "usertest": true
      },
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Update device

put

Update a single device from its given {deviceId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

deviceIdstringRequired

ID of the device

Body

application/json

typestring · enumOptionalPossible values:

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put/clip/v2/resource/device/{deviceId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/device/{deviceId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "identify": {
    "action": "identify"
  }
}

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

Delete Device

delete

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

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

deviceIdstringRequired

ID of the Device

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

delete/clip/v2/resource/device/{deviceId}

HTTPcURLJavaScriptPython

DELETE /clip/v2/resource/device/{deviceId} 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"
    }
  ]
}