Updating an alias

Written by

Updated at June 18, 2026

Warning

Yandex IoT Core is no longer available to new users.

Current users can create resources until November 1, 2026. Afterwards, the service will go read-only and cease to operate on December 1, 2026. For more information on the timing and procedure, see Service shutdown.

Aliases are linked to specific devices. To update an alias, you need the device ID or name.

Management console

CLI

Terraform

API

To update an alias:

In the management console, select a folder in which to update an alias.
Navigate to IoT Core.
Select the required registry from the list.
On the left side of the window, select the Devices section.
Click to the right of the appropriate device name and select Edit from the drop-down list.
Update the values of the alias fields.
Click Save.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

Update device aliases:

Warning

The existing topic_aliases will be completely overwritten by the ones you provide in your request.

yc iot device update first --topic-aliases 'events=$devices/areqjd6un3af********/events,commands=$devices/areqjd6un3af********/commands'

Result:

id: areqjd6un3af********
registry_id: arenou2oj4ct********
created_at: "2019-09-16T10:41:06.489Z"
name: first
topic_aliases:
  commands: $devices/areqjd6un3af********/commands
  events: $devices/areqjd6un3af********/events

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To update an alias created with Terraform:

Open the Terraform configuration file and edit the alias value in the aliases section, in the device description fragment.

Example device description in the Terraform configuration:

resource "yandex_iot_core_device" "my_device" {
  registry_id = "<registry_ID>"
  name        = "<device_name>"
  description = "test device for terraform provider documentation"

  aliases = {
    "some-alias1/subtopic" = "$devices/{id}/events/somesubtopic",
    "some-alias2/subtopic" = "$devices/{id}/events/aaa/bbb",
  }
...
}

For more information about yandex_iot_core_device properties, see this Terraform provider guide.

In the command line, change to the folder where you edited the configuration file.
Make sure the configuration file is correct using this command:
```
terraform validate
```
If the configuration is valid, you will get this message:
```
Success! The configuration is valid.
```
Run this command:
```
terraform plan
```
You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
Apply the configuration changes:
```
terraform apply
```
Confirm the changes: type yes into the terminal and press Enter.

You can verify device aliases in the management console or using the following CLI command:
```
yc iot device get <device_name>
```

To update an alias, use the update REST API method for the Device resource or the DeviceService/Update gRPC API call.

Updating an alias

Was the article helpful?