For the complete documentation index, see llms.txt. This page is also available as Markdown.

Zigbee Device Discovery

API to manage zigbee device discovery.

List zigbee device discovery.

get

List all available zigbee device discovery resources.

Authorizations
hue-application-keystringRequired
Responses
200

ZigbeeDeviceDiscovery Success Response

application/json
get/clip/v2/resource/zigbee_device_discovery
GET /clip/v2/resource/zigbee_device_discovery HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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"
      },
      "status": "active"
    }
  ]
}

Get zigbee device discovery.

get

Get details of a single zigbee device discovery resource from its given {zigbeeDeviceDiscoveryId}.

Authorizations
hue-application-keystringRequired
Path parameters
zigbeeDeviceDiscoveryIdstringRequired

ID of the zigbee device discovery

Responses
200

ZigbeeDeviceDiscovery Success Response

application/json
get/clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId}
GET /clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*
{
  "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"
      },
      "status": "active"
    }
  ]
}

Update zigbee device discovery.

put

Update a single zigbee device discovery resource from its given {zigbeeDeviceDiscoveryId}.

Authorizations
hue-application-keystringRequired
Path parameters
zigbeeDeviceDiscoveryIdstringRequired

ID of the zigbee device discovery

Body
typestringOptional

Type of the supported resources (always zigbee_device_discovery here)

Responses
200

Success

application/json
put/clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId}
PUT /clip/v2/resource/zigbee_device_discovery/{zigbeeDeviceDiscoveryId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

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

Last updated

Was this helpful?