go-unifi

List Devices Pending Adoption

Retrieve a paginated list of devices pending adoption, including basic device information. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`macAddress`|`STRING`|`eq` `ne` `in` `notIn`| |`ipAddress`|`STRING`|`eq` `ne` `in` `notIn`| |`model`|`STRING`|`eq` `ne` `in` `notIn`| |`state`|`STRING`|`eq` `ne` `in` `notIn`| |`supported`|`BOOLEAN`|`eq` `ne`| |`firmwareVersion`|`STRING`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `like` `in` `notIn`| |`firmwareUpdatable`|`BOOLEAN`|`eq` `ne`| |`features`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`| </details>

GET
/v1/pending-devices

Retrieve a paginated list of devices pending adoption, including basic device information.

NameTypeAllowed functions
macAddressSTRINGeq ne in notIn
ipAddressSTRINGeq ne in notIn
modelSTRINGeq ne in notIn
stateSTRINGeq ne in notIn
supportedBOOLEANeq ne
firmwareVersionSTRINGisNull isNotNull eq ne gt ge lt le like in notIn
firmwareUpdatableBOOLEANeq ne
featuresSET(STRING)isEmpty contains containsAny containsAll containsExactly
X-Api-Key<token>

UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).

In: header

Query Parameters

offset?integer
limit?integer
filter?string

Response Body

application/json

curl -X GET "https://example.com/v1/pending-devices"
{  "offset": 0,  "limit": 25,  "count": 10,  "totalCount": 1000,  "data": [    {      "macAddress": "94:2a:6f:26:c6:ca",      "ipAddress": "192.168.1.55",      "model": "UHDIW",      "state": "ONLINE",      "supported": true,      "firmwareVersion": "6.6.55",      "firmwareUpdatable": true,      "features": [        "switching"      ],      "adoptionTargetSiteIds": [        "60e22d2c-fe16-4dde-9494-122922abc5bc"      ]    }  ]}