Skip to content

Get discovery status ​

GET /clip/v2/resource/zigbee_device_discovery

Check whether Zigbee device discovery is running. The response includes the discovery service's UUID, which you need to start or stop discovery.

Example response

json
{
    "code": 0,
    "data": {
        "arr": [
            {
                "id": "576A6228-CB9E-48D2-B6B6-447C657CF465",
                "owner": {
                    "rid": "EA7297E0-5959-4585-9740-AA5BD41707D1",
                    "rtype": "device"
                },
                "status": "stopped",
                "type": "zigbee_device_discovery"
            }
        ],
        "len": 1,
        "obj": {}
    },
    "msg": "success"
}

Responses ​

Status codeMeaning
200OK

Response fields ​

HTTP 200 OK

FieldTypeRequiredDescription
codeintegerYesStatus code
msgstringYesMessage
dataobjectYesResponse payload.
data.objobjectYesReturned resource.
data.arrobject[]NoReturned resources.
data.arr[].idstringYesService UUID. Use this UUID to start or stop discovery.
data.arr[].ownerobjectYesOwning device
data.arr[].owner.ridstringYesDevice UUID.
data.arr[].owner.rtypestringYesDevice type
data.arr[].statusstringYesCurrent discovery status. start: discovery in progress; stop: discovery stopped.
data.arr[].typestringYesService type

Check your firmware: The field definition lists start and stop, while the example returns stopped. Check the values your gateway returns when handling discovery status.