Renaming Devices – Esper Help

This feature is available for: ✓ Templates ✓ Blueprints

Once a device is provisioned, it’s given a default ID such as ESP-AND-001. However, you can give alias names to devices as well. An alias name differs from a device’s API ID, which can be found in the URL or through the API. Device names, also known as alias names, do not have to be unique. Device alias names offer another way to quickly identify devices in the console. There are a few methods for renaming (also known as giving an alias to) a device.

In this article:

Device Name Conventions

A single device is composed of a Device Console ID, a Device API ID, and an optional Device Alias.

Type	Example	Used In	How to Find
Device Console ID*	EPR-NNP-AAAW3	The Console	In the Device ID column in Devices & Groups
Device API ID* (also called the device UUID)	e45facc9-6ec8-4dbf-af86-6853cef1633d	The API	In the URL when you click on the device in Devices & Groups
Device Alias	Andi’s Tablet	The Console	In the Alias column in Devices & Groups

*Note: The Device Console ID and Device API ID cannot be changed.

Rename a Device in the Console

Blueprints Templates

Navigate to Device & Groups, locate the device. Then, expand the Actions menu through the Ellipsis (...) button, and select and Rename Device.

Enter a custom name and click Rename.

device_rename_with_custom_alias_entered_as_Andi_s_Tablet.png

You can view the Alias in the Overview section of the device.

Navigate to Device & Groups, locate the device, and click the Device Rename button.

Select Custom alias name.

1_-_Device_Rename_modal_with_option_to_create_a_custom_alias.png

Enter a custom alias name and click Rename.

device_rename_with_custom_alias_entered_as_Andi_s_Tablet.png

The Alias Name will appear in the Alias Name Column.

information_tab_showing_the_device_name_and_console_id.png

Rename a Device via EAST

The EAST tool makes renaming devices in bulk quick and efficient, especially if they belong to the same Group. See Getting Started with EAST and Bulk Add Tags and Rename Devices.

Rename a Device via the API

Use the API to rename a device. Read more about Getting Started with the API.

API

POST https://{tenant_name}-api.esper.cloud/api/v0/enterprise/{enterprise_ID}/command/

Body

{
   "command_type": "DEVICE",
   "devices": [
       "device_id"
   ],
   "device_type": "all",
   "command": "UPDATE_DEVICE_CONFIG",
   "command_args": {
       "device_alias_name" : "alias_name"
   }
}

I Don't See Alias in Devices & Groups

This feature is available for: ✓ Blueprints

Don't see the device's alias in Devices & Groups?

You can also adjust your filters. In Devices & Groups, click on Views and select Customize List Views.

Then check the Alias box. You may need to press Default before being able to select it. Then press Save & Close.

The alias name column should appear, along with any other selected columns.