Skip to main content

Renaming Devices

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’s a few methods for renaming (also known as giving an alias to) a device. 

In this article: 

Device Name Conventions 

Here’s the ways that device names and IDs are used in Esper. A single device is composed of a Device Console ID, a Device API ID, and an optional Device Alias.

Type Example Used In
Device Console ID* EPR-NNP-AAAW3 The Console
Device API ID* e45facc9-6ec8-4dbf-af86-6853cef1633d The API
Device Alias Andi’s Tablet

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

Rename a Device in the Console 

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

Device_name_with_alias_name_button.png

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

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

Actions_elipsis_rename_device_selected.png

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. 

Overview_alias_.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.

east_with_alias_name_entered.png

Rename a Device via the API 

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

Endpoint 

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"
   }
}

 

Related articles

Featured Posts