Method get

Returns the specified registry.

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

HTTP request

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

Path parameters

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

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.

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. Мaximum 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.