Jetstream API
...
API Endpoints
Alias Configuration

Get an Alias

5min

About

Return a specified alias from your Jetstream application.

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 alias.

This value has a max length of 128 ASCII characters.

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

Example

Request URL

GET https://api.jetstreamrfid.com/3/aliases/{Alias Name}

Request Body

None Required

Response Code

200 OK

Response Body

{ "Id": 1, "Name": "MyAliasName", "Devices": [ "MyDeviceName1", "MyDeviceName2" ], "Region": "US" }

Version Changes

None – this is a new endpoint.