Gets the specified device.

get/api/edge/devices/{deviceId}

Path parameters

deviceIdstring required

The device identifier.

Response

deviceIdstring nullable

The IoT Edge identifier.

deviceNamestring required

The name of the device.

modelIdstring required

The model identifier.

imagestring nullable

The device model image Url.

connectionStatestring nullable

The IoT Edge connection state.

scopestring nullable

The IoT Edge scope tag value.

statusstring nullable

The IoT Edge device status.

runtimeResponsestring nullable

The IoT Edge runtime response.

nbDevicesinteger

The number of connected devices on IoT Edge device.

nbModulesinteger

The number of modules on IoT Edge device.

tagsobject nullable

List of custom device tags and their values.

isEnabledboolean

true if this instance is enabled; otherwise, false.

Changes

Changed in 1 of the 3 revisions of this API.339

Aug 20, 20268f5ec4f45de1339See the full diff
- ▲
  removed the required property modules/items/imageURI from the response with the 200 status (media type: text/plain)
  response-required-property-removed
- ▲
  removed the required property modules/items/imageURI from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property modules/items/imageURI from the response with the 200 status (media type: text/json)
  response-required-property-removed
- ●
  removed the optional property imageUrl from the response with the 200 status (media type: text/plain)
  response-optional-property-removed
- ●
  removed the optional property imageUrl from the response with the 200 status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property imageUrl from the response with the 200 status (media type: text/json)
  response-optional-property-removed
- ○
  added the optional property image to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property image to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property image to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the optional property modules/items/startupOrder to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property modules/items/startupOrder to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property modules/items/startupOrder to the response with the 200 status (media type: text/json)
  response-optional-property-added
- ○
  added the required property modules/items/image to the response with the 200 status (media type: text/plain)
  response-required-property-added
- ○
  added the required property modules/items/image to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property modules/items/image to the response with the 200 status (media type: text/json)
  response-required-property-added

Full history