Get started
Yandex IoT Core

IoT Core Broker Service, REST: Broker methods

Written by

A set of methods for managing broker.

JSON Representation

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

ID of the broker.
folderId string

ID of the folder that the broker 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 broker. The name is unique within the folder.
description string

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

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

Status of the broker.

  • CREATING: Broker is being created.
  • ACTIVE: Broker is ready to use.
  • DELETING: Broker is being deleted.

Methods

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