Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is delivered as a message to the controller instructing it to start the discovery.

post/device-discoveries

Request body

DiscoveryType'ZWAVE' | 'ZIGBEE' | 'CLOUD' | 'CUSTOM' | 'CONTROLLER_CAPABILITY_REDISCOVERY' required

The discovery type supporting the type of device to be discovered in the device discovery task request.

CustomProtocolDetailobject
<p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p> <note> <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p> </note>
ControllerIdentifierstring

The id of the end-user's IoT hub.

ConnectorAssociationIdentifierstring

ConnectorAssociationId is deprecated

AccountAssociationIdstring

The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

AuthenticationMaterialstring password

The authentication material required to start the local device discovery job request.

AuthenticationMaterialType'ZWAVE_INSTALL_CODE'

The type of authentication material used for device discovery jobs.

ClientTokenstring

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Tagsobject

A set of key/value pairs that are used to manage the device discovery request.

ConnectorDeviceIdListConnectorDeviceId[]

Used as a filter for PLA discoveries.

Protocol'ZWAVE' | 'ZIGBEE' | 'CUSTOM'
<p>The protocol type for capability rediscovery (ZWAVE, ZIGBEE, or CUSTOM).</p> <note> <p>This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.</p> </note>
EndDeviceIdentifierstring
<p>The unique id of the end device for capability rediscovery.</p> <note> <p>This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.</p> </note>

Response

Success

Idstring

The id of the device discovery job request.

StartedAtstring date-time

The timestamp value for the start time of the device discovery.