---
title: Create an Alias
slug: jetstream-v3/create-an-alias
docTags: 
createdAt: 2024-01-23T15:42:16.567Z
---

## About

Add an alias to your Jetstream application, defining which devices in your Jetstream application may take on this alias.

## Parameters

| **Property**                                                             | **Location**                        | **Details**                                                                                                                                                                                                                                                                                                                       |
| ------------------------------------------------------------------------ | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **AccessKey**<br />:::BlockQuote
string&#xA;Required&#xA;Unique
:::      | Header                              | The access key for your user account.<br />This value is a 36-character GUID provided in your [user profile](docId\:BbIFQiuIXND5iAfMreBBi).                                                                                                                                                                                       |
| **Id**<br />:::BlockQuote
ulong&#xA;Unique
:::                           | Body<br />*Response*                | The ID assigned to the newly created alias.<br />This value is generated by Jetstream – do not define it in requests.                                                                                                                                                                                                             |
| **Name**<br />:::BlockQuote
string&#xA;Required&#xA;Unique
:::           | Body<br />*Request*<br />*Response* | The name of the alias.<br />This value has a max length of 128 ASCII characters.<br />This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_,. ]\*$                                                                                                                                                                   |
| **Devices**<br />:::BlockQuote
array(string)&#xA;Required&#xA;Unique
::: | Body<br />*Request*<br />*Response* | The name(s) of the device(s) that can assume the alias.<br />This value has a max length of 128 ASCII characters.<br />This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_,. ]\*$<br />This property is required and must be included with all requests. If there are no devices to define, define an empty array. |
| **Region**<br />:::BlockQuote
string&#xA;Required
:::                    | Body<br />*Request*<br />*Response* | The geographic region that the RFID device is being placed. This is used to create the most reliable and lowest latency connection to the device<br />This value is one of the following possibilities: US, EU, AP, USGOV.                                                                                                        |

## Example

### Request URL

**POST** https\://api.jetstreamrfid.com/3/aliases

### Request Body

:::BlockQuote
\{
&#x20;   "Name": "MyAliasName",
&#x20;   "Devices": \[&#x20;
&#x20;           "MyDeviceName1", &#x20;
&#x20;           "MyDeviceName2"&#x20;
&#x20;   ],
&#x20;   "Region": "US"
}
:::

### Response Code

201 Created

### Response Body

:::BlockQuote
\{
&#x20;   "Id": 1,
&#x20;   "Name": "MyAliasName",
&#x20;   "Devices": \[&#x20;
&#x20;           "MyDeviceName1", &#x20;
&#x20;           "MyDeviceName2"&#x20;
&#x20;   ],
&#x20;   "Region": "US"
}
:::

## Version Changes

None – this is a new endpoint.