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
- Rename a Device in the Console
- Rename a Device via EAST
- Rename a Device via the API
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 |
Rename a Device in the Console
Navigate to Device & Groups, locate the device, and click the Device Rename button.
Select Custom alias name.
Enter a custom alias name and click Rename.
The Alias Name will appear in the Alias Name Column.
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.
You can view the Alias in the Overview section of the device.
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.
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"
}
}