# Avnet /IOTCONNECT Firmware API

**Canonical:** https://apis.io/apis/avnet/avnet-iotconnect-firmware-api/  
**Provider:** Avnet — https://apis.io/providers/avnet/  
**Base URL:** https://firmware.iotconnect.io  
**Documentation:** https://docs.iotconnect.io/iotconnect/rest-api/firmware/?env=prod&pf=az

Avnet /IOTCONNECT Firmware API is one of 9 APIs that [Avnet](https://apis.io/providers/avnet/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include IoT, Device Management, Telemetry, and Firmware. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and authentication docs.

Firmware packages, OTA upgrade scheduling and cancellation, module library and IoT Edge deployments. Part of Avnet's /IOTCONNECT IoT platform REST API (40 operations, API version 2); every request carries a JWT bearer token issued by the Authenticate API and the docs page serves the live Swagger 2.0 definition per module, environment and cloud platform (Azure or AWS).

## Operations (40)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v2/Firmware` | Add new firmware |
| GET | `/api/v2/Firmware` | Get firmware list |
| PUT | `/api/v2/Firmware/{firmwareGuid}` | Update Firmware |
| GET | `/api/v2/Firmware/{firmwareGuid}` | Get firmware details |
| GET | `/api/v2/Firmware/lookup` | Get firmware lookup list |
| POST | `/api/v2/firmware-validate` | Validate firmware |
| PUT | `/api/v2/Firmware/{firmwareGuid}/deprecate` | Deprecate Firmware |
| POST | `/api/v2/firmware-upgrade` | Add new firmware upgrade |
| GET | `/api/v2/firmware-upgrade` | Get firmware software list |
| PUT | `/api/v2/firmware-upgrade/{firmwareUpgradeGuid}` | Update firmware upgrade |
| DELETE | `/api/v2/firmware-upgrade/{firmwareUpgradeGuid}` | Delete firmware upgrade |
| GET | `/api/v2/firmware-upgrade/{firmwareUpgradeGuid}` | Get firmware upgrade details |
| PUT | `/api/v2/firmware-upgrade/{firmwareUpgradeGuid}/publish` | Publish firmware upgrade |
| GET | `/api/v2/firmware/{firmwareGuid}/lookup` | Get firmware software version lookup list |
| GET | `/api/v2/firmware-upgrade/lookup/{firmwareGuid}` | Get firmware upgrade lookup list |
| POST | `/api/v2/iot-edge/deployments` | Create new IoT Edge Deployment |
| GET | `/api/v2/iot-edge/deployments` | Get IoT edge deployment list |
| GET | `/api/v2/module-type/lookup` | Get module type lookup list |
| GET | `/api/v2/Module/lookup` | Get module lookup list |
| GET | `/api/v2/Module/{moduleGuid}` | Get module detail by moduleGuid |
| PUT | `/api/v2/Module/{moduleGuid}` | Update module by moduleGuid |
| DELETE | `/api/v2/Module/{moduleGuid}` | Delete module by moduleGuid |
| GET | `/api/v2/Module` | Get module list |
| POST | `/api/v2/Module` | Add module |
| POST | `/api/v2/Module/push` | Push a module on multiple devices |
| GET | `/api/v2/Module/push` | Get module push list |
| POST | `/api/v2/ota-update` | Send OTA update |
| GET | `/api/v2/ota-update` | Get OTA update sent list |
| GET | `/api/v2/ota-update/{otaUpdateGuid}` | Get device list for OTA update |
| GET | `/api/v2/ota-update/{otaUpdateGuid}/status/{status}` | Get device list for OTA update with update status |
| POST | `/api/v2/ota-update/device-update-history` | Get OTA update history for devices |
| GET | `/api/v2/ota-update/device/{deviceGuid}/recent` | Get recent OTA update list for a single device |
| PUT | `/api/v2/ota-update/device/{deviceGuid}/otaupdateItem/{otaUpdateItemGuid}/status/{status}` | Update device OTA update status using device guid |
| PUT | `/api/v2/ota-update/device/{uniqueId}/otaupdate-item/{otaUpdateItemGuid}/status/{status}` | Update device OTA update status using device unique id |
| GET | `/api/v2/device/{deviceGuid}/ota-update` | Get recent pending or failed OTA update list for a single device |
| GET | `/api/v2/ota-update/recent` | Get recent OTA updates list |
| GET | `/api/v2/ota-update/recent-activity` | Get recent OTA updates list for all devices |
| PUT | `/api/v2/ota-update/cancel-scheduled-otaupdate` | Update device OTA update cancel status |
| POST | `/api/v2/ota-update/otaUpdateFeedback/{otaUpdateItemGuid}` | Get ota update command feedback |
| GET | `/api/v2/ota-update/device/{deviceGuid}/ota-update` | Get OTA update list according a device |

## Machine-readable artifacts (8)

- **Documentation** — https://docs.iotconnect.io/iotconnect/rest-api/firmware/?env=prod&pf=az
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/openapi/avnet-iotconnect-firmware-openapi.yml
- **OpenAPI** — https://firmware.iotconnect.io/api/v2/swagger-json
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/authentication/avnet-authentication.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/overlays/avnet-iotconnect-firmware-overlay.yaml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/conventions/avnet-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/errors/avnet-problem-types.yml
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/skills/_index.yml

## Other Avnet APIs (8)

- [Avnet API Portal (Procurement APIs)](https://apis.io/apis/avnet/avnet-api-portal-procurement-apis/)
- [Avnet /IOTCONNECT Master API](https://apis.io/apis/avnet/avnet-iotconnect-master-api/)
- [Avnet /IOTCONNECT Authenticate API](https://apis.io/apis/avnet/avnet-iotconnect-authenticate-api/)
- [Avnet /IOTCONNECT User API](https://apis.io/apis/avnet/avnet-iotconnect-user-api/)
- [Avnet /IOTCONNECT Device API](https://apis.io/apis/avnet/avnet-iotconnect-device-api/)
- [Avnet /IOTCONNECT Event API](https://apis.io/apis/avnet/avnet-iotconnect-event-api/)
- [Avnet /IOTCONNECT Telemetry API](https://apis.io/apis/avnet/avnet-iotconnect-telemetry-api/)
- [Avnet /IOTCONNECT File API](https://apis.io/apis/avnet/avnet-iotconnect-file-api/)

## Tags

IoT, Device Management, Telemetry, Firmware

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/avnet/avnet-iotconnect-firmware-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/avnet/.
