Update device telemetry settings

PATCH 
/api/v1/devices/{deviceId}/telemetry-configs

Partially update telemetry configurations for a specific device. Applies to WEDA Node and SubNode. A Custom Device returns 404. Requires the admin role, and a WEDA Node must have finished onboarding; otherwise 403.

A sensor's runtime configuration may be sent as 'report' or as 'config'; sending both for the same sensor is rejected with 400 Bad Request. 'config' is the older key name and 'report' is the name this API is moving to. Start using 'report' now.

Within that object, 'enabled' and 'interval' are required. Omitting either is rejected rather than defaulted. An enabled interval, under 'report' or 'record', must be between 1000 and 86400000 milliseconds (1 second to 24 hours) by default; a deployment may configure different bounds, and a rejection states the bounds in force. A disabled interval is not checked. Everything else ('unit', 'transformPipeline', 'dspPipeline', 'thresholds') is optional and left as the device has it when omitted. A nested pipeline or 'thresholds' object that IS sent replaces its counterpart in full. There is no way to clear a field this way (omitting it means keep), so use the reset endpoint to drop a device's configuration.

A 202 response means the request was sent, not that the device applied it. To confirm, call GET and check that appliedAt is at or after updatedAt; status is then success, or failed or invalid with errorMessage. updatedAt is the server time when the request was received, and appliedAt is the device time when it reported the result, so this check assumes the device clock is accurate. A new PATCH does not clear status or appliedAt. They keep the previous result until the device reports again.

Request

Responses

202

Request accepted and desired configuration sent to device

400

Invalid request shape (both 'report' and 'config' for one sensor, or a missing 'enabled'/'interval'), an unknown sensor or schema, an enabled interval outside the allowed range (1000–86400000 ms by default; the rejection states the bounds in force), the caller's resource_access claim could not be parsed, or the resulting configuration was refused, naming the sensors and fields it refused

401

Authentication is required

403

The caller is not an admin of the organization owning this device, or the device has not finished onboarding

404

Device not found, or outside the organizations the caller can access

502

The device's telemetry configuration does not conform to the expected format, so it cannot be used as the baseline for this update

503

The device's capability report could not be read, so the sensor names in this request could not be checked. Transient; retry.