Share via

API versions of Azure IoT Central Data Plane REST APIs

  • Article

This article lists the current and past versions of the REST APIs for Azure IoT Central.

Stable versions

These versions are the stable releases that can be used to develop production solutions with Azure IoT Central.

API version Specification API updates
2022-07-31 (Latest) Swagger specification Release note
2022-05-31 (Deprecated) Swagger specification Release note
1.0 (Deprecated) Swagger specification Release note

Preview versions

Preview versions are released to test new functionality, gather feedback, and discover and fix issues. Preview APIs are available under Supplemental Terms of Use, and aren't recommended for production workloads.

API version Specification API updates
2022-10-31-preview (Latest) Swagger specification Release note
2022-06-30-preview (Deprecated) Swagger specification Release note
1.2-Preview (Deprecated) Swagger specification Release note
1.1-Preview (Deprecated) Swagger specification Release note

Release notes

2022-10-31-preview

The preview release of Azure IoT Central REST Data Plane API on October 31, 2022 delivers a series of improvements to existing endpoints and adds several new endpoints to enable the following key capabilities.

  • The property query feature of the current Query API is no longer supported and has limited the rate to one request per minute.

    Note

    This feature will be removed by June 30, 2023.

  • Support for creating and managing the lifecycle for 'Microsoft Edge Deployment Manifests'.

    Note

    These manifests have now been decoupled from the device templates and can be managed independently.

  • Removal of 'deploymentManifest' from 'DeviceTemplate' definition. Per the above change, deployment manifests are now independent.

    Note

    This update is a breaking change behavior from the previous 2022-06-30-preview release.

  • Support for a new 'iotEdge' type has been added to the 'Device' entity as a 'type: string[]'. This field enables the user to identify a device as an IoT Edge enabled device. This field is an optional type and you can continue creating and managing device instances without it.

    
{

    "type": ["iotEdge"]

}

  • Support for a new applyDeploymentManifest route to Device. This operation enables you to associate an IoT Edge Deployment Manifest to a device instance.

  • Support for new optional field readAccess to FileUpload configuration.

  • Support for idScope within the EnrollmentGroup entity for convenient access.

  • Updated support for paging with new parameters including maxpagesize, filter, orderby. And the previously supported parameters including $filter, $top, $orderby have now been retired.

  • Support for new deviceManifestMigration job type. This new job type enables you to manage your fleet of Edge devices and configure a deploymentManifest for them.

2022-07-31

Our latest GA release on July 31, 2022 improves the previously existing 2022-05-31 release and is fully backwards compatible. As of today, the 2022-05-31 release is now marked for deprecation and we'll look to end support for it by July 2025. Here are set of updates captured in this release:

  • Jobs with progress status support
  • Scheduled Jobs support
  • Device Enrollment Groups support
  • Device Relationships support
  • Device Groups List Devices support

2022-06-30-preview

The preview release of Azure IoT Central REST Data Plane API on June 30, 2022 delivers a series of improvements to existing endpoints and adds support for the following key capabilities:

  • Support for creating and managing Enrollment Groups for device onboarding
  • Ability to create and configure Scheduled Jobs
  • Support for programmatically creating Application Dashboard via REST API
  • Support for unmodeled properties and commands for Device
  • Ability to list devices within a Device Group
  • Support progress summary from job
  • Removed name field from Device Relationship

2022-05-31

Our latest GA release on May 31, 2022 improves the previously existing 1.0 release and is fully backwards compatible. As of today, the 1.0 release is now marked for deprecation and we'll look to end support for it by May 2025. Here are set of updates captured in this release:

  • File Upload Storage Configuration Support
  • Device Group CRUD Support
  • Organization CRUD Support
  • Organization Support on Devices, Roles, Users, and API Tokens

1.2-Preview (Deprecated)

The 1.2-preview release continuously improves our API endpoints from previous preview releases and adds support for the following features:

  • Device Group CRUD support
  • New job type to support device template migration

1.0

First GA REST API release for Azure IoT Central that captures support for the following endpoints: Devices, Roles List, Users, Device Templates, and API Tokens. You can learn more about each of the endpoints here.

  • Users without organization support.
  • Roles list without organization support.
  • Devices CRUD, properties, commands, credentials, attestation support.
  • API Tokens without organization support.
  • Device Template without PATCH support.

1.1-Preview (Deprecated)

This release enable support for DTDL v2 within the REST API surface for Azure IoT Central. It includes breaking changes from legacy preview version (now deprecated).

  • DTDLv2 alignment, read more details.
  • Device Relationship support.
  • FileUpload configuration support.
  • Organization support.
  • Device Telemetry Query support.
  • Jobs support.
  • Removed legacy Continuous Data Export Support.
  • Add Data Export V2 Export/Destination support.
  • Removed api/devices/{deviceId}/cloudProperties, using api/devices/{deviceId}/properties.
  • Device properties and telemetries under inherited interface won't be treated as root property and root telemetry.
  • Device Template patching support.
  • Edge manifest support from device template.

Preview (Deprecated & Removed)

First version of Azure IoT Central public API, with support for DTDL v1 only, has now been deprecated and removed from our REST API endpoints.

See also