Jetstream API
...
API Endpoints
Device Configuration
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 in your getting started docid\ bbifqiuixnd5iafmrebbi id ulong unique body response the id assigned to the newly created device this value is generated by jetstream – do not define it in requests name string required unique body request response 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 request response 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 request response 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 docid\ zre5zpbxavj78epzuxb84 request this value has a max length of 128 ascii characters this value must adhere to this regular expression ^\[a za z0 9 , ] $ the proper device definition for your device can always be provided by terso support https //www tersosolutions com/support/ 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 policy string body response the name of the policy associated with the device 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 array(string) required unique body request response the names of the aliases that the device can assume each value has a max length of 128 ascii characters each 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 aliases to define, define an empty array example request url post https //api jetstreamrfid com/3/devices request body { "name" "mydevicename", "serialnumber" "mydeviceserialnumber", "devicedefinition" "ts032, cabinet, us, uhf, gf, 7 9 cu ft, v4", "region" "us", "aliases" \[ "myaliasname1", "myaliasname2" ] } response code 201 created response body { "id" 1, "name" "mydevicename", "serialnumber" "mydeviceserialnumber", "devicedefinition" "ts032, cabinet, us, uhf, gf, 7 9 cu ft, v4", "region" "us", "policy" "", "aliases" \[ "myaliasname1", "myaliasname2" ] } version changes addition of the id property addition of the aliases property generates a deviceaddedevent docid\ bi2z5 siwyl1qen5dtde7