Sign in

v1

latestOpenAPI 3.1.02026-07-22154213404.8 KB
Devices

Update device name

Sets the display name for a device from the name in the request body and returns the updated device.

put/devices/{deviceId}/name

Path parameters

deviceIdstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

namestring required

Example request

{
  "$schema": "https://example.com/schemas/UpdateNameInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

activeTaskIdstring required
assignedAtstring date-time nullable required
billingStrategystring
createdAtstring date-time required
createdBystring
idstring required
namestring required
ownerIdstring
providerIdstring
statestring required
stateMessagestring required
streamTokenstring
streamUrlstring required
taskCountinteger required
terminatesAtstring date-time nullable required
typestring required
updatedAtstring date-time required
userIdstring

Deprecated: use ownerId/createdBy.

Example response

{
  "$schema": "https://example.com/schemas/DeviceInfo.json"
}