Modify an Alias

6min

About
Overwrite the name or device list of the specified alias with a new name or set of devices.
Parameters
Property
Location
Details
AccessKey
string
Required
Unique
Header
The access key for your user account.
This value is a 36-character GUID provided in your user profile﻿.
AliasName
string
Required
Unique
URL
The name of the existing alias.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
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-_,. ]*$
If the device(s) that can assume the alias is/are not changing, define the existing device name(s).
If the name of the alias is not changing, the defined devices will be associated with the existing alias name.
If the name of the alias is changing, the defined devices will be associated with the new alias name.
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.
Example
Request URL
PUT https://api.jetstreamrfid.com/3/aliases/{Alias Name}
Request Body
{
    "Name": "MyNewAliasName",
    "Devices": [ 
            "MyExistingDeviceName1",  
            "MyExistingDeviceName2",
            "MyNewDeviceName3"
    ],
    "Region": "US"
}
Response Code
200 OK
Response Body
{
    "Id": 1,
    "Name": "MyNewAliasName",
    "Devices": [ 
            "MyExistingDeviceName1",  
            "MyExistingDeviceName2",
            "MyNewDeviceName3"
    ],
    "Region": "US"
}
Version Changes
None – this is a new endpoint.

Property	Location	Details
AccessKey string Required Unique	Header	The access key for your user account. This value is a 36-character GUID provided in your user profile.
AliasName string Required Unique	URL	The name of the existing alias. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
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-_,. ]*$ If the device(s) that can assume the alias is/are not changing, define the existing device name(s). If the name of the alias is not changing, the defined devices will be associated with the existing alias name. If the name of the alias is changing, the defined devices will be associated with the new alias name. 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.

Updated 30 Jan 2024

Create an Alias

Delete an Alias