---
title: "GET /api/edge/models/{edgeModelId}"
method: GET
path: "/api/edge/models/{edgeModelId}"
tags: ["IoT Edge Devices Models"]
---

# GET /api/edge/models/{edgeModelId}

`GET /api/edge/models/{edgeModelId}`

## Path parameters

- `edgeModelId` string, required

## Response `200`

OK

- IoTEdgeModel
  - `modelId` string, nullable — The device model identifier.
  - `name` string, required — The IoT Edge device model name.
  - `description` string, nullable — The device model description.
  - `imageUri` string, nullable
  - `externalIdentifier` string, nullable — The aws deployment ID.
  - `labels` LabelDto[], nullable — Labels
    - `name` string, required
    - `color` string, required
  - `edgeModules` IoTEdgeModule[], nullable — The device model module list.
    - `id` string, nullable — The module name, only used for AWS IoT Greengrass.
    - `moduleName` string, required — The module name.
    - `image` string, required — the device image URI.
    - `containerCreateOptions` string, nullable
    - `startupOrder` integer
    - `status` string, nullable — The module status.
    - `environmentVariables` IoTEdgeModuleEnvironmentVariable[], nullable — The module environment variables.
      - `name` string, nullable — The module environment variable name
      - `value` string, nullable — The module environment variable value
    - `moduleIdentityTwinSettings` IoTEdgeModuleTwinSetting[], nullable — The module identity twin settings.
      - `name` string, nullable — The module identity twin setting name
      - `value` string, nullable — The module identity twin setting value
    - `commands` IoTEdgeModuleCommand[], nullable — The module commands.
      - `name` string, nullable — The command name
      - `edgeDeviceModelId` string, nullable
      - `commandId` string, nullable
      - `moduleName` string, nullable
    - `version` string, nullable
  - `edgeRoutes` IoTEdgeRoute[], nullable
    - `name` string, required — The route name.
    - `value` string, required — The route value. Eg : FROM /messages/* INTO $upstream.
    - `priority` integer, nullable — The route priority
    - `timeToLive` integer, nullable — The route time to live (secs)
  - `systemModules` EdgeModelSystemModule[], nullable
    - `name` string, nullable
    - `imageUri` string, nullable
    - `containerCreateOptions` string, nullable
    - `startupOrder` integer
    - `environmentVariables` IoTEdgeModuleEnvironmentVariable[], nullable
      - `name` string, nullable — The module environment variable name
      - `value` string, nullable — The module environment variable value

---

[API](https://skmtc.net/cgi-fr/apis/azure-iot-hub-portal-api.md) · [All operations](https://skmtc.net/cgi-fr/apis/azure-iot-hub-portal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cgi-fr/azure-iot-hub-portal-api/revisions/8f5ec4f45de1/schema)