Get started
Yandex IoT Core

IoT Core Service, REST: Registry.getByName

Written by

HTTP request

GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries:getByName

Query parameters

Parameter Description
folderId

Required. ID of the folder to list registries in.

To get a folder ID make a list request.

The maximum string length in characters is 50.
registryName

Required. Name of the registry to return.

To get a registry Name make a list request.

The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]*.

Response

HTTP Code: 200 - OK

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

A registry. For more information, see Registry.

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.
In this article: