Avnet /IOTCONNECT Device API
Device templates, attributes, commands, certificates, groups, rules, settings, direct methods, telemetry export, Azure Device Update groups and deployments — the largest module (158 paths). Part of Avnet's /IOTCONNECT IoT platform REST API (190 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 190
GET
/api/v2/adu-groups
Get ADU Group list
POST
/api/v2/adu-groups
Create ADU Group.
POST
/api/v2/template-attribute
Add new template attribute
PUT
/api/v2/template-attribute/{attributeGuid}
Update template attribute
DELETE
/api/v2/template-attribute/{attributeGuid}
Delete a template attribute
PUT
/api/v2/template-attribute/{attributeGuid}/sequence
Update template attribute sequence
GET
/api/v2/template-attribute/{deviceTemplateGuid}
Get template attribute list
GET
/api/v2/template-attribute/{deviceTemplateGuid}/lookup
Get device template attribute lookup
GET
/api/v2/sphere-devices/products
Get Sphere Product List
POST
/api/v2/sphere-devices/products
Create sphere product
PATCH
/api/v2/sphere-devices/products/{guid}
Update sphere product
DELETE
/api/v2/sphere-devices/products/{guid}
Delete sphere product
GET
/api/v2/sphere-devices/products/{guid}
Get Sphere Product Detail
GET
/api/v2/sphere-devices/tenants/{tenantId}/permission
Check iotconnect tenant has permission to access azure sphere tenant or not.
POST
/api/v2/sphere-devices/devices/syncDeviceDetail
Sync devicegroup and product from Azure sphere tenant
POST
/api/v2/Certificate
Add new certificate
GET
/api/v2/Certificate
Get device certificates list
PUT
/api/v2/Certificate/{certificateGuid}
Update certificate detail
DELETE
/api/v2/Certificate/{certificateGuid}
Delete a certificate
GET
/api/v2/Certificate/{certificateGuid}
Get single certificate detail
PUT
/api/v2/Certificate/{certificateGuid}/verify
Verify certificate
GET
/api/v2/certificate/lookup/{authType}
Get certificates lookup
GET
/api/v2/device/{deviceId}/self-signed-certificate
Get self signed certificate for your device
GET
/api/v2/certificate/count
Get certificates count
GET
/api/v2/device/{uniqueId}/platform/{platformType}/certificate-bundle
Get certificate for your device according to platformType
POST
/api/v2/CloudTemplate/device
Add new device
PUT
/api/v2/CloudTemplate/{deviceGuid}
Update a device
DELETE
/api/v2/CloudTemplate/{deviceGuid}
Delete a CloudTemplate device
GET
/api/v2/CloudTemplate/device/{uniqueId}
Get all the details of single device
GET
/api/v2/CloudTemplate
Get Device List
POST
/api/v2/CloudTemplate/convert-template
Convert CloudTemplate to DeviceTemplate
GET
/api/v2/CloudTemplate/device/{cloudTemplateDeviceGuid}/attribute-list
Get all the attribute of cloudTemplateDevice
PUT
/api/v2/CloudTemplate/attribute/{attributeGuid}
Update a cloudTemplate attribute
PUT
/api/v2/CloudTemplate/bulk-delete
Delete multiple devices
GET
/api/v2/CloudTemplate/batch-bulk-delete/{batchGuid}/devices
Get deleted device list based on batchguid
GET
/api/v2/CloudTemplate/device-delete-history-list
Get device delete history list
POST
/api/v2/template-command
Add new template command
PUT
/api/v2/template-command/{commandGuid}
Update template command
DELETE
/api/v2/template-command/{commandGuid}
Delete a command
GET
/api/v2/template-command/{deviceTemplateGuid}
Get device template command list
GET
/api/v2/template-command/{deviceTemplateGuid}/lookup
Get device template command lookup
POST
/api/v2/template-command/device/{deviceGuid}/send
Execute a command on device
POST
/api/v2/template-command/send
Execute a command on multiple devices
PUT
/api/v2/template-command/CommandSchedule/{commandScheduleGuid}
Update a scheduled command
DELETE
/api/v2/template-command/CommandSchedule/{commandScheduleGuid}
Delete a scheduled command
GET
/api/v2/template-command/CommandSchedule/{CommandScheduleGuid}
Get scheduled command detail
GET
/api/v2/template-command/CommandSchedule
Get scheduled command list
PUT
/api/v2/template-command/CommandSchedule/{commandScheduleGuid}/status
Update scheduled command Status
GET
/api/v2/template-command/history
Get device active commands
POST
/api/v2/template-command/history
Get device command history
PUT
/api/v2/template-command/{deviceGuid}/status
Update command history status
PUT
/api/v2/template-command/history/{commandHistoryGuid}/re-send
Resend commands
GET
/api/v2/template-command/batch/{batchGuid}
Get executed command list by batch
DELETE
/api/v2/template-command/Command-history/device/{deviceGuid}/from/{fromDate}/to/{toDate}
Delete a command-history
DELETE
/api/v2/template-command/Command-history/from/{fromDate}/to/{toDate}/Edge/{isEdgeSupport}/IotEdge/{iotEdgeEnable}/Gateway/{isGateway}/LowBandwidth/{isLowBandwidth}
Delete a command-history
POST
/api/v2/template-command/commandFeedback/{commandHistoryGuid}
Get device command feedback
POST
/api/v2/template-command/device/{deviceGuid}/history
Get device command history combined for dashboard
POST
/api/v2/data-export
Export telemetry Data
GET
/api/v2/data-export
Get data export request list
POST
/api/v2/data-export/child
Export child telemetry Data
GET
/api/v2/deployments
Get Deployment list
POST
/api/v2/deployments
Create scheduled deployment for device update.
POST
/api/v2/Device
Add new device
GET
/api/v2/Device
Get Device List
PUT
/api/v2/Device/{deviceGuid}
Update a device
DELETE
/api/v2/Device/{deviceGuid}
Delete a device
PUT
/api/v2/Device/{uniqueId}/acquire
Acquire device broker info from cloud
PUT
/api/v2/Device/{uniqueId}/release
Release device from cloud
PUT
/api/v2/Device/{deviceGuid}/status
Update device status
GET
/api/v2/Device/uniqueId/{uniqueId}
Get all the details of single device
GET
/api/v2/Device/lookup
Get device lookup
GET
/api/v2/template/{templateGuid}/device
Get device list by templateGuid
GET
/api/v2/entity/{entityGuid}/device
Get device list by entityGuid
PUT
/api/v2/entity/{entityGuid}/device
Update device entity in bulk
GET
/api/v2/company/{companyGuid}/device
Get company wise device list
GET
/api/v2/Device/{deviceGuid}/child-device
Get list of child devices
POST
/api/v2/import-batch
Import devices in batch
GET
/api/v2/import-batch
Get device batch import list
POST
/api/v2/template/{templateGuid}/import-batch-validate
Import devices in batch
GET
/api/v2/import-batch/{importBatchGuid}
Get list of all devices from a batch import request
POST
/api/v2/import-batch/child-device
Import child devices in batch
PUT
/api/v2/Device/entity/{entityGuid}/change
Update device entity in bulk with file or json
PUT
/api/v2/Device/device-transfer/{entityGuid}
Update device entity in bulk with file or json
PUT
/api/v2/Device/{uniqueId}/twin
Update device twin property
GET
/api/v2/Device/{uniqueId}/twin
Get device twin property list
GET
/api/v2/Device/{uniqueId}/twinjson
Get device twin property json
PUT
/api/v2/Device/{deviceGuid}/properties
Update device properties
DELETE
/api/v2/Device/{deviceGuid}/property/{deviceInfoGuid}
Delete a device property
GET
/api/v2/Device/property
Get device property list
POST
/api/v2/Device/{deviceGuid}/grant
Grant device permission
GET
/api/v2/Device/{deviceGuid}/grant
Get device permissions list
PUT
/api/v2/Device/user-device-permission/{userDevicePermissionGuid}
Update device permissions
DELETE
/api/v2/Device/user-device-permission/{userDevicePermissionGuid}/revoke
Revoke device permissions
GET
/api/v2/Device/recent-activity
Get recently acquired device list
GET
/api/v2/Device/{uniqueId}/lifecycle
Get device life cycle
GET
/api/v2/Device/connection-status
Get device connection status
GET
/api/v2/Device/connection-status/bulk
Get device connection status for multiple devices
GET
/api/v2/Device/count
Get device count
GET
/api/v2/Device/counters
Get device count statistics
POST
/api/v2/Device/diagnostics
Get device diagnostics detail
POST
/api/v2/Device/{deviceGuid}/direct-method
Execute direct method on device
GET
/api/v2/Device/{deviceGuid}/direct-method
Get list of direct method on device
GET
/api/v2/Device/statistic
Get device count statistics
GET
/api/v2/Device/DeviceDashboardCount
Get device dashboard count
DELETE
/api/v2/Device/property/{propertyGuid}/company/{companyGuid}
Delete a device property
GET
/api/v2/Device/unassociated
Get Device List
PUT
/api/v2/Device/unassociated/attach/bulk
Attach unassociated devices in bulk
PUT
/api/v2/Device/unassociated/attach
Attach unassociated device
DELETE
/api/v2/Device/unassociated/{deviceGuid}
Delete a unassociated device
GET
/api/v2/Device/audit-log
Get invalid device communications
POST
/api/v2/validate-external-device
Validate External devices in batch
POST
/api/v2/external-device-batch-import
External devices batch import
PUT
/api/v2/Device/bulk-delete
Delete multiple devices
GET
/api/v2/Device/batch-bulk-delete/{batchGuid}/devices
Get deleted device list based on batchguid
GET
/api/v2/device-delete-historylist
Get device delete history list
GET
/api/v2/device-delete-history-list
Get device delete history list
GET
/api/v2/external-device-batch-import-file/{importBatchGuid}
Get external device import file content
GET
/api/v2/Device/importTypes/lookup
Get import type lookup
GET
/api/v2/Device/import-type/lookup
Get import type lookup
PUT
/api/v2/Device/{deviceGuid}/devicetemplate/{deviceTemplateGuid}
Update template of device
GET
/api/v2/external-device-validated/{importBatchGuid}/{isSuccess}
Get external device import file content
PUT
/api/v2/Device/{uniqueId}/uploadsecondarycertificate
Upload secondary Certificate
GET
/api/v2/Device/configDetail/{deviceGuid}
Get Device Config Detail
DELETE
/api/v2/Device/import-batch/{importBatchGuid}
Delete a device import validation
POST
/api/v2/company/{companyGuid}/device-operation/{deviceGuid}/archive-data
Archive device telemetry data
GET
/api/v2/company/{companyGuid}/device-operation/{deviceGuid}/archive-data
Device operation history list for archive device telemetry data
GET
/api/v2/device-updates/devices/lookup
Get device lookup
GET
/api/v2/device-updates/devices
Get devices which has tag assigned.
GET
/api/v2/device-updates
Get device updates list
POST
/api/v2/device-updates/tags
Add Device Tag
POST
/api/v2/device-updates/import-update
Import Device Update
GET
/api/v2/device-updates/import-history
Get import history
POST
/api/v2/template-direct-method
Add new direct method
PUT
/api/v2/template-direct-method/{directMethodGuid}
Update a direct method
DELETE
/api/v2/template-direct-method/{directMethodGuid}
Delete a direct method
GET
/api/v2/template-direct-method/{deviceTemplateGuid}
Get device template direct methods list
GET
/api/v2/template-direct-method/{deviceTemplateGuid}/lookup
Get device template direct methods lookup
GET
/api/v2/Group/types
Get group type list
POST
/api/v2/Group
Add new group
GET
/api/v2/Group
Get group list
PUT
/api/v2/Group/{groupGuid}
Update group name / Sphere group details
DELETE
/api/v2/Group/{groupGuid}
Delete a group
GET
/api/v2/Group/{groupGuid}
Get group detail
GET
/api/v2/Group/lookup
Get group lookup list
POST
/api/v2/Group/device
Add devices in a group
DELETE
/api/v2/Group/{groupGuid}/device/{deviceGuid}
Delete a device from a group
GET
/api/v2/Group/{groupGuid}/device
Get device list for a group
POST
/api/v2/Group/user
Add users in a group
PUT
/api/v2/Group/{groupGuid}/user/{userGuid}
Update user permission in a group
DELETE
/api/v2/Group/{groupGuid}/user/{userGuid}
Delete a user from a group
GET
/api/v2/Group/{groupGuid}/user
Get user list for a group
POST
/api/v2/Rule
Add new rule
GET
/api/v2/Rule
Get rules list
PUT
/api/v2/Rule/{ruleGuid}
Update template rule
DELETE
/api/v2/Rule/{ruleGuid}
Delete rule
GET
/api/v2/Rule/{ruleGuid}
Get details of a single rule
POST
/api/v2/Rule/verify
Verify rule condition
PUT
/api/v2/Rule/{ruleGuid}/status
Update rule status
GET
/api/v2/Rule/counters
Get smart rule count
GET
/api/v2/Rule/{ruleGuid}/history
Get Rule History.
GET
/api/v2/Rule/conditions
Get rule conditions.
POST
/api/v2/template-setting
Add new twin property
DELETE
/api/v2/template-setting/{settingGuid}
Delete a twin property
GET
/api/v2/template-setting/{deviceTemplateGuid}
Get device template twin properties list
GET
/api/v2/template-setting/{deviceTemplateGuid}/lookup
Get device template twin properties lookup
GET
/api/v2/device/{deviceGuid}/template-setting
Get device twin properties list
PUT
/api/v2/template-setting/readOnly/{settingGuid}
Update a readOnly property
GET
/api/v2/template-setting/{deviceTemplateGuid}/devices/lookup
Get top 10 devices by template/solutiontemplate.
POST
/api/v2/device-template
Add new Device Template
GET
/api/v2/device-template
Get device template list
POST
/api/v2/device-template/quick
Add quick Device Template
PUT
/api/v2/device-template/{templateGuid}
Update device template
DELETE
/api/v2/device-template/{templateGuid}
Delete device template
GET
/api/v2/device-template/{deviceTemplateGuid}
Get all the details of single device template
GET
/api/v2/device-template/{deviceTemplateGuid}/lookup
Get JSON view of the device template
GET
/api/v2/device-template/{deviceTemplate}/tag-lookup
Get all the tags of a device template
GET
/api/v2/device-template/lookup
Get device template list lookup
GET
/api/v2/device-template/spherelookup
Get unassociate device template list lookup
GET
/api/v2/device-template/{solutionGuid}/spherelookup
Get unassociate device template list lookup using solutionguid
GET
/api/v2/device-template/datatype
Get datatype list
GET
/api/v2/device-template/datatype/{templateGuid}
Get datatype list
GET
/api/v2/device-template/{templateGuid}/export
Export template
GET
/api/v2/device-template/device/notification
Get device notification list
GET
/api/v2/device-template/lookup/twin
Get templates which have twins.
GET
/api/v2/device-template/template-code/{templateCode}
Get all the details of single device template using template code
GET
/api/v2/device-template/lookup/trusted-partners
Get trusted partner
GET
/api/v2/device-template/auth-type
Get Auth Type
PUT
/api/v2/device-template/{templateGuid}/property
Add/Update device template property.
PUT
/api/v2/device-template/{deviceGuid}/updatedevicetemplate
Update created device template
GET
/api/v2/device-template/devicetemplatechange-lookup
Get device template list lookup
Documentation
📖
Documentation
https://docs.iotconnect.io/iotconnect/rest-api/device/?env=prod&pf=az
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/authentication/avnet-authentication.yml
Specifications
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/openapi/avnet-iotconnect-device-openapi.yml
⚙
OpenAPI
https://device.iotconnect.io/api/v2/swagger-json
⚙
OpenAPI
https://deviceconsole.iotconnect.io/api/v2.1/swagger-json
Other Resources
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/overlays/avnet-iotconnect-device-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
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/data-model/avnet-data-model.yml
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/avnet/refs/heads/main/skills/_index.yml