Jetstream API
...
API Endpoints
Alias Configuration

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 getting started docid\ bbifqiuixnd5iafmrebbi 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