API Changes — v1.1.0
API changes from v1.0.0 to v1.1.0 that affect client code, one row per endpoint, grouped by API category. For a narrative summary of this release, see v1.1.0.
- Paths are relative to
/api/v1. - Client Impact: Breaking — existing client code must change · Additive — new or backward-compatible; adopt only if you want the new capability.
- Change types: Added (new endpoint) · Path changed (same operation, new path; old route deprecated) · Modified (request/response contract changed, same path) · Removed (temp) (not available this version; returns in a future release).
- This page lists only endpoints with real contract impact. Endpoints with documentation/example-only or purely behavioral changes are omitted.
Container Management, Notifications, and Tunnels have no API contract changes in v1.1.0 (verified by resolved-schema comparison of the specs). Any runtime/behavioral improvements in those areas are described in the v1.1.0 release notes, not here.
Identity & Access
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Retrieve all organization roles linked to the specified user | GET | /users/{userId}/orgs | Modified | Breaking | Response changed from a top-level array to a paged object { items[], totalCount } — the list is now nested under items |
Devices
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Get device data source definitions | GET | /devices/{deviceId}/data-source | Added | Additive | New endpoint |
| Get device data objects | GET | /devices/{deviceId}/data-objects | Added | Additive | New endpoint |
| Get data object by ID | GET | /devices/{deviceId}/data-objects/{dataObjectId} | Added | Additive | New endpoint |
| Get devices with pagination | GET | /devices | Modified | Breaking | Response items[].name renamed to deviceName |
| Update a device | PATCH | /devices/{deviceId} | Modified | Additive | New optional request field deviceName; response adds deviceName |
| Update device status | POST | /devices/{deviceId}:{status} | Modified | Additive | {status} path value adds activate (was deactivate only); response adds deviceName |
| List Weda Nodes by Organization | GET | /orgs/{orgId}/devices | Modified | Additive | Response adds deviceName |
| Register a device to an organization | POST | /orgs/{orgId}/devices | Modified | Additive | New optional request field deviceName; response adds deviceName |
Batch Tasks
The entire Tasks and Batches feature set is removed in v1.1.0 (temporary; returns in a future release). Clients using any of these must migrate off Batch Tasks.
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Get a paginated list of tasks by organization | GET | /orgs/{orgId}/tasks | Removed (temp) | Breaking | Returns in a future version |
| Create a new task under an organization | POST | /orgs/{orgId}/tasks | Removed (temp) | Breaking | Returns in a future version |
| Get a task by ID | GET | /orgs/{orgId}/tasks/{taskId} | Removed (temp) | Breaking | Returns in a future version |
| Update a task | PUT | /orgs/{orgId}/tasks/{taskId} | Removed (temp) | Breaking | Returns in a future version |
| Delete a task | DELETE | /orgs/{orgId}/tasks/{taskId} | Removed (temp) | Breaking | Returns in a future version |
| Get batch list of an Org | GET | /orgs/{orgId}/batches | Removed (temp) | Breaking | Returns in a future version |
| Create a new batch under org | POST | /orgs/{orgId}/batches | Removed (temp) | Breaking | Returns in a future version |
| Get a batch by ID | GET | /orgs/{orgId}/batches/{batchId} | Removed (temp) | Breaking | Returns in a future version |
| Update an existing batch | PUT | /orgs/{orgId}/batches/{batchId} | Removed (temp) | Breaking | Returns in a future version |
| Update only actions of a batch | PATCH | /orgs/{orgId}/batches/{batchId} | Removed (temp) | Breaking | Returns in a future version |
| Delete a batch safely | DELETE | /orgs/{orgId}/batches/{batchId} | Removed (temp) | Breaking | Returns in a future version |
| Trigger a batch execution | POST | /orgs/{orgId}/batches/{batchId}:start | Removed (temp) | Breaking | Returns in a future version |
| Enable or disable an existing batch | PUT | /orgs/{orgId}/batches/{batchId}/status | Removed (temp) | Breaking | Returns in a future version |
| Get results of a batch | GET | /orgs/{orgId}/batches/{batchId}/results | Removed (temp) | Breaking | Returns in a future version |
| Get trigger list for a batch | GET | /orgs/{orgId}/batches/{batchId}/triggers | Removed (temp) | Breaking | Returns in a future version |
| Get devices associated with a batch | GET | /orgs/{orgId}/batches/{batchId}/devices | Removed (temp) | Breaking | Returns in a future version |
Data Objects
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Retrieve the latest value of a specific data object | GET | /devices/{deviceId}/data-objects/{dataObjectId}/values/latest | Added | Additive | New endpoint |
| Get assigned device binary data | GET | /devices/{deviceId}/data-objects/{dataObjectId}/blobs/{blobKey} | Added | Additive | New endpoint (binary / image data) |
| Get data history | GET | /devices/{deviceId}/data-objects/{dataObjectId}/values/historical | Path changed | Breaking | was /devices/{deviceId}/data-objects/values; now requires dataObjectId |
| List alert rules | GET | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules | Path changed | Breaking | was /devices/{deviceId}/data-objects/alert-rules; now requires dataObjectId. Response adds dataObjectId |
| Create alert rule | POST | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules | Path changed | Breaking | was /devices/{deviceId}/data-objects/alert-rules; now requires dataObjectId. Response adds dataObjectId |
| Get alert rule by ID | GET | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId} | Path changed | Breaking | was .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId. Response adds dataObjectId |
| Update alert rule | PATCH | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId} | Path changed | Breaking | was .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId. Response adds dataObjectId |
| Delete alert rule | DELETE | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId} | Path changed | Breaking | was .../data-objects/alert-rules/{alertRuleId}; now requires dataObjectId |
| Update alert rule status | PUT | /devices/{deviceId}/data-objects/{dataObjectId}/alert-rules/{alertRuleId}/status | Path changed | Breaking | was .../data-objects/alert-rules/{alertRuleId}/status; now requires dataObjectId. Response adds dataObjectId |
| List transfer functions | GET | /devices/{deviceId}/inputs/data-objects/transfer-functions | Path changed | Breaking | was /devices/{deviceId}/data-objects/transfer-functions. Response field dataObjectName renamed to outputDataObjectName |
| Create transfer function | POST | /devices/{deviceId}/inputs/data-objects/transfer-functions | Path changed | Breaking | was /devices/{deviceId}/data-objects/transfer-functions. Request expression now required; response dataObjectName renamed to outputDataObjectName |
| Get transfer function | GET | /devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId} | Path changed | Breaking | was .../data-objects/transfer-functions/{transferFunctionId}. Response dataObjectName renamed to outputDataObjectName |
| Update transfer function | PATCH | /devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId} | Path changed | Breaking | was .../data-objects/transfer-functions/{transferFunctionId}. Response dataObjectName renamed to outputDataObjectName |
| Delete transfer function | DELETE | /devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId} | Path changed | Breaking | was .../data-objects/transfer-functions/{transferFunctionId} |
| Update transfer function status | PATCH | /devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}/status | Path changed | Breaking | was .../data-objects/transfer-functions/{transferFunctionId}/status. Response dataObjectName renamed to outputDataObjectName |
Reports
The Subscriptions feature is removed in v1.1.0 (temporary; returns in a future release).
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Get all Subscriptions | GET | /reports/subscriptions | Removed (temp) | Breaking | Returns in a future version |
| Create a new Subscription | POST | /reports/subscriptions | Removed (temp) | Breaking | Returns in a future version |
| Get a Subscription | GET | /reports/subscriptions/{subscriptionId} | Removed (temp) | Breaking | Returns in a future version |
| Update a Subscription | PUT | /reports/subscriptions/{subscriptionId} | Removed (temp) | Breaking | Returns in a future version |
| Delete a Subscription | DELETE | /reports/subscriptions/{subscriptionId} | Removed (temp) | Breaking | Returns in a future version |
| Get Subscription Deliveries | GET | /reports/subscriptions/{subscriptionId}/deliveries | Removed (temp) | Breaking | Returns in a future version |
| Update Subscription Status | PATCH | /reports/subscriptions/{subscriptionId}/status | Removed (temp) | Breaking | Returns in a future version |
| Execute a Subscription | POST | /reports/subscriptions/{subscriptionId}:execute | Removed (temp) | Breaking | Returns in a future version |
The usage-jobs endpoints are unchanged for clients. Their documented 400/500 error responses were removed from the spec (a Swagger cleanup); the errors still occur at runtime, so no code change is needed.
Model Management
New service in v1.1.0 — all endpoints are new (additive; no existing client is affected).
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Create Model | POST | /orgs/{orgId}/ai-models | Added | Additive | New endpoint |
| List Models for an Organization | GET | /orgs/{orgId}/ai-models | Added | Additive | New endpoint |
| Update Model Basic Info | PATCH | /orgs/{orgId}/ai-models/{modelId} | Added | Additive | New endpoint |
| Delete a Model and All Its Editions | DELETE | /orgs/{orgId}/ai-models/{modelId} | Added | Additive | New endpoint |
| List Editions of a Model | GET | /orgs/{orgId}/ai-models/{modelId}/editions | Added | Additive | New endpoint |
| Register New Edition of an Existing Model | POST | /orgs/{orgId}/ai-models/{modelId}/editions | Added | Additive | New endpoint |
| Get Model Edition Detail | GET | /orgs/{orgId}/ai-models/{modelId}/editions/{edition} | Added | Additive | New endpoint |
| Update Edition Metadata | PATCH | /orgs/{orgId}/ai-models/{modelId}/editions/{edition} | Added | Additive | New endpoint |
| Delete a Single Edition | DELETE | /orgs/{orgId}/ai-models/{modelId}/editions/{edition} | Added | Additive | New endpoint |
Model Uploads
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Create a resumable upload | POST | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads | Added | Additive | New endpoint |
| Upload a file chunk | PATCH | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId} | Added | Additive | New endpoint |
| Get current upload offset | HEAD | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId} | Added | Additive | New endpoint |
| Terminate an upload | DELETE | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId} | Added | Additive | New endpoint |
| Get Upload Status | GET | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/uploads/{uploadId}/status | Added | Additive | New endpoint |
Model Deployments
| API Name | Method | Endpoint | Change | Impact | Details |
|---|---|---|---|---|---|
| Create Deployment | POST | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}:deploy | Added | Additive | New endpoint |
| List Devices for a Specific Model Edition | GET | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/deployments | Added | Additive | New endpoint |
| Delete Model File from All Deployed Devices | DELETE | /orgs/{orgId}/ai-models/{modelId}/editions/{edition}/deployments | Added | Additive | New endpoint |
| List All AI Models for a Specific Device | GET | /devices/{deviceId}/ai-models | Added | Additive | New endpoint |
| Delete Model File from a Specific Device | DELETE | /devices/{deviceId}/ai-models/{modelId}/editions/{edition} | Added | Additive | New endpoint |
Related
- Narrative summary of this release: v1.1.0