Create an Alias

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

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.

Id

ulong
Unique

Body

Response

The ID assigned to the newly created alias.

This value is generated by Jetstream – do not define it in requests.

Name

string
Required
Unique

Body

Request Response

The name of the alias.

This value has a max length of 128 ASCII characters.

This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$

Devices

array(string)
Required
Unique

Body

Request Response

The name(s) of the device(s) that can assume the alias.

This value has a max length of 128 ASCII characters.

This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$

This property is required and must be included with all requests. If there are no devices to define, define an empty array.

Region

string
Required

Body

Request 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

This value is one of the following possibilities: US, EU, AP, USGOV

Request URL

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

Request Body

{
    "Name": "MyAliasName",
    "Devices": [ 
            "MyAliasName1",  
            "MyAliasName2" 
    ],
    "Region": "US"
}

Response Code

201 Created

Response Body

{
    "Id": 1,
    "Name": "MyAliasName",
    "Devices": [ 
            "MyAliasName1",  
            "MyAliasName2" 
    ],
    "Region": "US"
}
None – this is a new endpoint.