CGcgi-fr
IoT Edge Devices

Gets the specified device.

Changed on
get/api/edge/devices/{deviceId}

Request

Path parameters

deviceIdstring required

The device identifier.

Response

OK

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

  • 8f5ec4f45de1Revision changes
    • breaking

      removed the required property // from the response with the status (media type: text/plain)

    • breaking

      removed the required property // from the response with the status (media type: application/json)

    • breaking

      removed the required property // from the response with the status (media type: text/json)

    • warning

      removed the optional property from the response with the status (media type: text/plain)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

    • info

      added the required property // to the response with the status (media type: text/plain)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/json)