Get started
Yandex IoT Core

IoT Core Service, REST: Registry methods

Written by

A set of methods for managing registry.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string",
  "logGroupId": "string"
}
Field Description
id string

ID of the registry.
folderId string

ID of the folder that the registry belongs to.
createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name string

Name of the registry. The name is unique within the folder.
description string

Description of the registry. 0-256 characters long.
labels object

Resource labels as key:value pairs. Maximum of 64 per resource.
status string

Status of the registry.

  • CREATING: Registry is being created.
  • ACTIVE: Registry is ready to use.
  • DELETING: Registry is being deleted.
logGroupId string

ID of the logs group for the specified registry.

Methods

Method Description
addCertificate Adds a certificate.
addPassword Adds password for the specified registry.
create Creates a registry in the specified folder.
delete Deletes the specified registry.
deleteCertificate Deletes the specified registry certificate.
deletePassword Deletes the specified password.
get Returns the specified registry.
getByName
list Retrieves the list of registries in the specified folder.
listCertificates Retrieves the list of registry certificates for the specified registry.
listDeviceTopicAliases Retrieves the list of device topic aliases for the specified registry.
listOperations Lists operations for the specified registry.
listPasswords Retrieves the list of passwords for the specified registry.
update Updates the specified registry.
In this article: