All notable changes to the APIs are documented in this file.
Based on: https://keepachangelog.com/en/1.1.0/
Group changes to describe their impact on the project, as follows:
Addedfor new features.Changedfor changes in existing functionality.Deprecatedfor once-stable features removed in upcoming releases.Removedfor deprecated features removed in this release.Fixedfor any bug fixes.Securityto invite users to upgrade in case of vulnerabilities.
- The response for the
GET /devices/v1/devicesandGET /devices/v1/devices/{id}endpoints now includes the following additional subscription fields:key,tier,startDate,endDate.
- The response for the
GET /devices/v1/devicesandGET /devices/v1/devices/{id}endpoints now includes the following additional location fields:city,state,country,latitude,longitude,postalCode,locationName,streetAddress, andlocationSource.
- The response for the
GET /devices/v1/devicesandGET /devices/v1/devices/{id}endpoints now includes three new fields:deviceName,secondaryName, anddedicatedPlatformWorkspace. - The rate limit for
PATCH /devices/v2beta1/devicesandPATCH /devices/v1/deviceshas been raised to 20 requests per minute per workspace.
- A new response field,
assignedState, was added to the response of theGET /devices/v1/devicesandGET /devices/v1/devices/{id}API endpoints.
The following API endpoints were added
POST /devices/v2beta1/devicesPATCH /devices/v2beta1/devices
- The
POST /devices/v1/devicesandPATCH /devices/v1/devicesAPI endpoints support the newdry-runquery parameter
As part of the transition to the stable v1 version, the following endpoints were added:
POST /devices/v1/devicesPATCH /devices/v1/devicesGET /devices/v1/devicesGET /devices/v1/async-operations/{id}GET /devices/v1/devices/{id}
As part of the transition to the stable v1 version, the following v1beta1 endpoints were deprecated and will no longer be available from 2025-05-05:
POST /devices/v1beta1/devicesPATCH /devices/v1beta1/devicesGET /devices/v1beta1/devicesGET /devices/v1beta1/async-operations/{id}GET /devices/v1beta1/devices/{id}
- The rate limits for the
POST /devices/v1beta1/devices,GET /devices/v1beta1/devicesandGET /devices/v1beta1/async-operations/{id}APIs have increased.
The following public APIs were added:
GET /devices/v1beta1/devices/{id}
- The
GET /devices/v1beta1/devicesAPI now supports filtering supports IN, NOT along with exiting operators. Filter based on Tags is also supported.
The initial public APIs were added:
POST /devices/v1beta1/devicesPATCH /devices/v1beta1/devicesGET /devices/v1beta1/devicesGET /devices/v1beta1/async-operations/{id}