---
title: Create a Device
slug: jetstream-v3/create-a-device
docTags: 
createdAt: 2024-01-23T15:29:21.081Z
---

## About

Add a device to your Jetstream application, making the device ready to receive your commands and push events.

## Parameters

| **Property**                                             | **Location**                        | **Details**                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **AccessKey**<br />string<br />Required<br />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 />ulong<br />Unique                            | Body<br />*Response*                | The ID assigned to the newly created device.<br />This value is generated by Jetstream – do not define it in requests.                                                                                                                                                                                                                                                                                                                                                             |
| **Name**<br />string<br />Required<br />Unique           | Body<br />*Request*<br />*Response* | The name of the device.<br />This value has a max length of 128 ASCII characters.<br />This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_,. ]\*$                                                                                                                                                                                                                                                                                                                   |
| **SerialNumber**<br />string<br />Required<br />Unique   | Body<br />*Request*<br />*Response* | The physical serial number of the device.<br />This value has a max length of 128 ASCII characters.<br />This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_]\*$                                                                                                                                                                                                                                                                                                    |
| **DeviceDefinition**<br />string<br />Required           | Body<br />*Request*<br />*Response* | The name of the device definition associated with the device.<br />This value is one of the device definitions retrieved by the [Get All Device Definitions](docId\:ZrE5zpBxavj78EPZuxb84) request.<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 />The proper device definition for your device can always be provided by [Terso Support](https://www.tersosolutions.com/support/). |
| **Region**<br />string<br />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.                                                                                                                                                                                                                                                         |
| **Policy**<br />string                                   | Body<br />*Response*                | The name of the policy associated with the device.<br />This value is set via the [Add a Policy to a Device](docId:8iiNKl-mZ80HPIut5zv2e) request. Attempting to set this any other way or not defining this property will result in an empty string value.                                                                                                                                                                                                                        |
| **Aliases**<br />array(string)<br />Required<br />Unique | Body<br />*Request*<br />*Response* | The names of the aliases that the device can assume.<br />Each value has a max length of 128 ASCII characters.<br />Each 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 aliases to define, define an empty array.                                                                                                                                                     |

## Example

### Request URL

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

### Request Body

:::BlockQuote
\{
&#x20;   "Name": "MyDeviceName",
&#x20;   "SerialNumber": "MyDeviceSerialNumber",
&#x20;   "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
&#x20;   "Region": "US",
&#x20;   "Aliases": \[&#x20;
&#x20;           "MyAliasName1", &#x20;
&#x20;           "MyAliasName2"&#x20;
&#x20;   ]
}
:::

### Response Code

201 Created

### Response Body

:::BlockQuote
\{
&#x20;   "Id": 1,
&#x20;   "Name": "MyDeviceName",
&#x20;   "SerialNumber": "MyDeviceSerialNumber",
&#x20;   "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
&#x20;   "Region": "US",
&#x20;   "Policy": "",
&#x20;   "Aliases": \[&#x20;
&#x20;           "MyAliasName1", &#x20;
&#x20;           "MyAliasName2"&#x20;
&#x20;   ]
}
:::

## Version Changes

- Addition of the Id property.
- Addition of the Aliases property.
- Generates a [DeviceAddedEvent](docId\:bI2z5-sIwyL1Qen5dtde7).

