Get started
Yandex IoT Core

IoT Core Broker Service, REST: Broker.list

Written by

Retrieves the list of brokers in the specified folder.

HTTP request

GET https://iot-broker.api.cloud.yandex.net/iot-broker/v1/brokers

Query parameters

Parameter Description
folderId

Required. ID of the folder to list brokers 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

{
  "brokers": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
brokers[] object

List of brokers.
brokers[].
id		 string

ID of the broker.
brokers[].
folderId		 string

ID of the folder that the broker belongs to.
brokers[].
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).
brokers[].
name		 string

Name of the broker. The name is unique within the folder.
brokers[].
description		 string

Description of the broker. 0-256 characters long.
brokers[].
labels		 object

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

Status of the broker.

  • CREATING: Broker is being created.
  • ACTIVE: Broker is ready to use.
  • DELETING: Broker is being deleted.
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.
In this article: