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

Zigbee Connectivity

API to manage zigbee connectivity status.

List zigbee connectivity.

get

List all available zigbee connectivity resources.

Authorizations
hue-application-keystringRequired
Responses
200

ZigbeeConnectivity Success Response

application/json
get/clip/v2/resource/zigbee_connectivity
GET /clip/v2/resource/zigbee_connectivity 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": "connected",
      "mac_address": "text",
      "channel": {
        "status": "set",
        "value": "channel_11"
      },
      "extended_pan_id": "text"
    }
  ]
}

Get zigbee connectivity.

get

Get details of a single zigbee connectivity resource from its given {zigbeeConnectivityId}.

Authorizations
hue-application-keystringRequired
Path parameters
zigbeeConnectivityIdstringRequired

ID of the zigbee connectivity

Responses
200

ZigbeeConnectivity Success Response

application/json
get/clip/v2/resource/zigbee_connectivity/{zigbeeConnectivityId}
GET /clip/v2/resource/zigbee_connectivity/{zigbeeConnectivityId} 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": "connected",
      "mac_address": "text",
      "channel": {
        "status": "set",
        "value": "channel_11"
      },
      "extended_pan_id": "text"
    }
  ]
}

Update zigbee connectivity.

put

Update a single zigbee connectivity resource from its given {zigbeeConnectivityId}.

Authorizations
hue-application-keystringRequired
Path parameters
zigbeeConnectivityIdstringRequired

ID of the zigbee connectivity

Body
typestringOptional

Type of the supported resources (always zigbee_connectivity here)

Responses
200

Success

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

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

Last updated

Was this helpful?