CGcgi-fr
IoT Edge Devices

Creates the IoT Edge device.

Changed on
post/api/edge/devices

Request

Request body

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.

Response

OK

Changes

  • 8f5ec4f45de1Revision changes
    • breaking

      added the new required request property // (media type: application/json)

    • breaking

      added the new required request property // (media type: text/json)

    • breaking

      added the new required request property // (media type: application/*+json)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the request property // (media type: text/json)

    • warning

      removed the request property // (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: text/json)

    • info

      added the new optional request property // (media type: application/*+json)