Method get

Returns the specified device.

To get the list of available devices, make a list request.

HTTP request

GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices/{deviceId}

Path parameters

Parameter Description
deviceId Required. ID of the device to return. To get a device ID make a list request. The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "registryId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "topicAliases": "object"
}

A device. For more information, see Device.

Field Description
id string

ID of the device.

registryId string

ID of the registry that the device belongs to.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.

name string

Name of the device. The name is unique within the registry.

description string

Description of the device. 0-256 characters long.

topicAliases object

Alias of a device topic.

Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. my/custom/alias match to $device/abcdef/events.