Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex IoT Core
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Sending messages
    • Subscribing a device or registry to receive messages
    • Viewing the connection log
    • Creating a trigger for a topic
    • Managing registries
      • Getting information about registries
      • Creating a registry
      • Updating a registry
      • Deleting a registry
    • Managing devices
      • Managing topic aliases
        • Creating an alias
        • Getting a list of aliases
        • Updating an alias
        • Deleting an alias
      • Getting information about devices
      • Creating a device
      • Updating a device
      • Deleting a device
    • Managing certificates
      • Create a certificate
      • Managing registry certificates
      • Managing device certificates
    • Managing passwords
      • Managing registry passwords
      • Managing device passwords
  • Concepts
    • Authorization
    • Relationship between service resources
    • MQTT broker connection parameters
    • Sending messages to an MQTT broker via gRPC
    • Topic
    • Backups
    • Quotas and limits
  • Use cases
    • All use cases
    • Working with Mosquitto
      • Sending messages
      • Subscribing a device or registry to receive messages
    • Working with Yandex IoT Core from an Android device in Java
    • Working with Yandex IoT Core in C#
    • Working with Yandex IoT Core in Java
    • Writing data from a device to Managed Service for PostgreSQL
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • DeviceDataService
      • DeviceService
      • RegistryDataService
      • RegistryService
      • OperationService
    • REST
      • Overview
      • Device
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • list
        • listCertificates
        • listOperations
        • listPasswords
        • update
      • DeviceData
        • Overview
        • publish
      • Registry
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • list
        • listCertificates
        • listDeviceTopicAliases
        • listOperations
        • listPasswords
        • update
      • RegistryData
        • Overview
        • publish
  • Questions and answers
  1. API reference
  2. REST
  3. Device
  4. Overview

Device

  • JSON Representation
  • Methods

A set of methods for managing devices.

JSON Representation

{
  "id": "string",
  "registryId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "topicAliases": "object",
  "status": "string",
  "monitoringData": {
    "lastAuthIp": "string",
    "lastAuthTime": "string",
    "lastPubActivityTime": "string",
    "lastSubActivityTime": "string",
    "lastOnlineTime": "string"
  }
}
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.

status string

Status of the device.

  • CREATING: Device is being created.
  • ACTIVE: Device is ready to use.
  • DELETING: Device is being deleted.
monitoringData object

Device monitoring data, returns if FULL view specified.

monitoringData.
lastAuthIp
string
monitoringData.
lastAuthTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastPubActivityTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastSubActivityTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastOnlineTime
string (date-time)

String in RFC3339 text format.

Methods

Method Description
addCertificate Adds a certificate.
addPassword Adds password for the specified device.
create Creates a device in the specified registry.
delete Deletes the specified device.
deleteCertificate Deletes the specified device certificate.
deletePassword Deletes the specified password.
get Returns the specified device.
list Retrieves the list of devices in the specified registry.
listCertificates Retrieves the list of device certificates for the specified device.
listOperations Lists operations for the specified device.
listPasswords Retrieves the list of passwords for the specified device.
update Updates the specified device.
In this article:
  • JSON Representation
  • Methods
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC