How to authenticate BaseSpace CLI to another region or Enterprise domain

There are multiple instances of BaseSpace to serve different regions around the world. These instances are housed in separate data centers and have different base URLs for the API. The default API URL when using the bs authenticate command is: https://api.basespace.illumina.com, which is the USE1 region based in Virginia, USA.

The instances and their respective API URLs are listed below.

Region Name	Country	City/State	API URL
USE1 (default)	USA	Virginia, USA	https://api.basespace.illumina.com
EUC1	Europe	Frankfurt, Germany	https://api.euc1.sh.basespace.illumina.com
APS2	Australia	Sydney, Australia	https://api.aps2.sh.basespace.illumina.com
CAC1	Canada	Montreal, Canada	https://api.cac1.sh.basespace.illumina.com
CNN	China	Beijing, China	https://api.cnn1.sh.basespace.illumina.com.cn
EUW2	UK	London, UK	https://api.euw2.sh.basespace.illumina.com

To authenticate on an instance other than USE1 the --api-server option must be used in conjunction with the appropriate API URL. For example, to authenticate to EUC1, the following command can be used:

bs auth --api-server https://api.euc1.sh.basespace.illumina.com  

Note: The --api-server must be used when authenticating to a non-USE1 instance (for Personal (Basic) accounts and Professional or Enterprise workgroups). When authenticating to a Professional or Enterprise workgroup (on USE1), the --api-server option is not needed, and users can authenticate the same way they would for a Personal account.

For any feedback or questions regarding this article (Illumina Knowledge Article #5560), contact Illumina Technical Support [e-mail].