Method list

Written by

HTTP request
Query parameters
Response

Retrieves the list of registries in the specified folder.

HTTP request

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

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.
pageSize	The maximum number of results per page that should be returned. If the number of available results is larger than `page_size`, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken	Page token. To get the next page of results, set `page_token` to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "registries": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "logGroupId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field	Description
registries[]	object A registry. For more information, see Registry.
registries[]. id	string ID of the registry.
registries[]. folderId	string ID of the folder that the registry belongs to.
registries[]. createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
registries[]. name	string Name of the registry. The name is unique within the folder.
registries[]. description	string Description of the registry. 0-256 characters long.
registries[]. labels	object Resource labels as `key:value` pairs. Maximum of 64 per resource.
registries[]. status	string Status of the registry. CREATING: Registry is being created. ACTIVE: Registry is ready to use. DELETING: Registry is being deleted.
registries[]. logGroupId	string ID of the logs group for the specified registry.
nextPageToken	string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use `next_page_token` as the value for the pageToken parameter in the next list request. Each subsequent page will have its own `next_page_token` to continue paging through the results.