Skip to main content

Update a data stream

PATCH 
/api/v1/orgs/{orgId}/devices/{deviceId}/data-streams/{dataStreamId}

Update one or more fields of a specific data stream. Only the provided fields will be updated; omitted fields retain their current values. displayName, description, unitDisplay, and recordToDataLake are editable regardless of managedBy (User or System).

Parameters

  • deviceId (string, required): Unique ID of the device. Example: 74fe488d5d35
  • dataStreamId (Guid, required): Unique ID of the data stream. Example: e033b4b3-36e0-4dbc-a6e4-1e77185402f4

Responses

  • 200 OK: Data stream patched successfully.
  • 400 Bad Request: Invalid request body.
  • 403 Forbidden: The device identified by deviceId does not belong to the caller's organization.
  • 404 Not Found: Data stream not found, or no device with the given deviceId exists.
  • 503 Service Unavailable: The device lookup used to validate deviceId did not respond in time.

Security

  • This API requires authentication.

Request​

Responses​

Data stream patched successfully.