Devices

Update an existing device attributes

patch/devices/{deviceId}

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

applyProfilestring

Optionally apply a profile to the device to update unset attributes with attributes from the profile.

Request body

category'group' | 'device'

Category of entity.

deviceIdstring required

Globally unique id of the Device.

templateIdstring required

Template of Device.

descriptionstring

Description of the group.

awsIotThingArnstring

Arn of the device if registered within the AWS IoT registry.

imageUrlstring

URL of an image of the device.

connectedboolean

AWS IoT connectivity status

state'unprovisioned' | 'active' | 'decommissioned' | 'retired'

The current state of the device

attributesobject
relationstring

Name of relation to this device (readonly, populated when displaying related devices only)

direction'in' | 'out'

Direction of relation (readonly, populated when displaying related devices only)

groupsobject

Paths of the groups that this Device is associated with.

devicesobject

Ids of the devices that this Device is associated with.

Response

successful operation

Changes

No recorded changes to this operation across all 12 revisions of this API.