Create a Device

6min

About
Add a device to your Jetstream application, making the device ready to receive your commands and push events.
Parameters
Property
Location
Details
AccessKey
string
Required
Unique
Header
The access key for your user account.
This value is a 36-character GUID provided during user account sign up.
Name
string
Required
Unique
Body
The name of the device.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
SerialNumber
string
Required
Unique
Body
The physical serial number of the device.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
DeviceDefinition
string
Required
Body
The name of the device definition associated with the device.
This value is one of the device definitions retrieved by the Get All Device Definitions﻿ request.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
Region
string
Required
Body
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
This value is one of the following possibilities: US, EU, AP, USGOV
Policy
string
Body
The name of the policy associated with the device.
This value is set via the Add a Policy to a Device﻿ request. Attempting to set this any other way or not defining this property will result in an empty string value.
Example
Request URL
POST https://api.jetstreamrfid.com/2/devices
Request Body
{
    "Name": "MyDeviceName",
    "SerialNumber": "MyDeviceSerialNumber",
    "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
    "Region": "US"
}
Response Code
201 Created
Response Body
{
    "Name": "MyDeviceName",
    "SerialNumber": "MyDeviceSerialNumber",
    "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
    "Region": "US",
    "Policy": ""
}

Version Changes
Replaces AddLogicalDevice

Property	Location	Details
AccessKey string Required Unique	Header	The access key for your user account. This value is a 36-character GUID provided during user account sign up.
Name string Required Unique	Body	The name of the device. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
SerialNumber string Required Unique	Body	The physical serial number of the device. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
DeviceDefinition string Required	Body	The name of the device definition associated with the device. This value is one of the device definitions retrieved by the Get All Device Definitions request. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
Region string Required	Body	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 This value is one of the following possibilities: US, EU, AP, USGOV
Policy string	Body	The name of the policy associated with the device. This value is set via the Add a Policy to a Device request. Attempting to set this any other way or not defining this property will result in an empty string value.

Updated 25 Mar 2024

Device Configuration

Delete a Device