Get All Aliases

5min

About
Return all aliases 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﻿.
Id
ulong
Searchable
Sortable
URL
The ID of the Alias.
Name
string
Searchable
Sortable
URL
The name of the alias.
Region
string
Searchable
Sortable
URL
The geographic region to retrieve the alias names from.
To return all alias names from all regions, do not define this property nor assign it a value.
If this property is defined, its value is one or a combination of the following possibilities: US, EU, AP, USGOV.
Example
Request URL
GET https://api.jetstreamrfid.com/3/aliases
Request Body
None Required
Response Code
200 OK
Response Body
[
    {
        "Id": 1,
        "Name": "MyAliasName1",
        "Devices": [ 
                "MyDeviceName1",  
                "MyDeviceName2"
        ],
        "Region": "US"
    },
    {
        "Id": 2,
        "Name": "MyAliasName2",
        "Devices": [ 
                "MyDeviceName1",  
                "MyDeviceName2"
        ],
        "Region": "US"
    },
    {
        "Id": 3,
        "Name": "MyAliasName3",
        "Devices": [ 
                "MyDeviceName1",  
                "MyDeviceName2"
        ],
        "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.
Id ulong Searchable Sortable	URL	The ID of the Alias.
Name string Searchable Sortable	URL	The name of the alias.
Region string Searchable Sortable	URL	The geographic region to retrieve the alias names from. To return all alias names from all regions, do not define this property nor assign it a value. If this property is defined, its value is one or a combination of the following possibilities: US, EU, AP, USGOV.

Updated 30 Jan 2024

Get an Alias

Get All Alias Names