Creating a User API Key

  • Updated

Introduction

To use the Flywheel CLI or SDK to interact with your Flywheel site requires creating and authenticating with an API Key. Starting with Flywheel Enterprise version 16.19.0, only Enhanced API Keys can be created, while prior versions permit creating Legacy API Keys. Use of existing Legacy API Keys will not be supported in a future major version update of Flywheel Enterprise.

Warning

Support for Legacy API Keys will end with the 18.0 release of Flywheel Enterprise expected to be released in February 2024. Once upgraded to version 18.0.0 or later, a Flywheel site will reject all authentication attempts that use Legacy API Keys.

Caution

Do not share your API key. This key should be treated like a password used to sign into Flywheel.

 

About Key Generation

Key Expiration Requirements

  • With FWE 17.4 expiration dates are required on all Enhanced API Keys.
  • For existing API Keys the expiration date will be set to 1 year from the time of upgrade.
  • For new API Keys the expiration date will be set by the user at the time the key is created.
  • A warning will be displayed upon user login for API Keys that are expired or about to expire.

Multiple API Keys

  • Starting with FWE 17.4, users can provision and apply a new API Key before the existing one in use is deleted or expires.
  • Up to 5 Enhanced API Keys per user and per device are permitted.

 

Key Generation

Generate an API Key (Enhanced)

To use the Flywheel CLI or SDK to interact with your Flywheel site; generate an API key by following the below steps:

1. Log into Flywheel

2. In the upper-right corner, select your account menu and select Profile.

 

Screen_Shot_2018-08-29_at_11.13.53_AM.png

3. Scroll down to to the Flywheel Access section.

 

User Profile - API Keys - empty.png

4. Click Generate API Key

5. Provide a name for your key, select its expiration date and click Add Key.

 

Generate API Key User.png

 

6. Copy the new key and save it securely. It will not be accessible again.

 

Screen_Shot_2023-05-03_at_7.47.46_AM.png

 

Generate an API Key (Legacy)

To start using the CLI to interact with your Flywheel site; generate an API key.

1. Log into Flywheel

2. In the upper-right corner, select your account menu and select Profile.

 

Screen_Shot_2018-08-29_at_11.13.53_AM.png

3. Scroll down to to the API Key section.

 

360044575273-FlywheelUserProfile-export.png

4. Click Generate API Key

 

Resources