Sign in

v8

latestSwagger 2.02026-07-13120150263.9 KB

Update a device via patch

Update an existing device by ID.

patch/devices/{deviceId}

Path parameters

deviceIdstring required

Unique ID of the device.

Query parameters

api-versionstring required

The version of the API being called.

expandstring

The query parameter for including requested entities in response.

Headers

If-Matchstring

Only perform the operation if the entity's etag matches one of the etags provided or * is provided.

Request body

object required

Response

Success

idstring

Unique ID of the device.

etagstring

ETag used to prevent conflict in device updates.

displayNamestring

Display name of the device.

templatestring

The device template definition for the device.

enabledboolean

Whether the device connection to IoT Central has been enabled.

provisionedboolean

Whether resources have been allocated for the device.

simulatedboolean

Whether the device is simulated.

organizationsstring[]

List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon.

typestring[]

The type of the device.